.TH r.report 1grass "" "GRASS 6.4.4" "Grass User's Manual"
.SH NAME
\fI\fBr.report\fR\fR  - Reports statistics for raster map layers.
.SH KEYWORDS
raster, statistics
.SH SYNOPSIS
\fBr.report\fR
.br
\fBr.report help\fR
.br
\fBr.report\fR [\-\fBqhfenNCi\fR] \fBmap\fR=\fIname\fR[,\fIname\fR,...]  [\fBunits\fR=\fIstring\fR[,\fIstring\fR,...]]   [\fBnull\fR=\fIstring\fR]   [\fBpl\fR=\fIinteger\fR]   [\fBpw\fR=\fIinteger\fR]   [\fBoutput\fR=\fIstring\fR]   [\fBnsteps\fR=\fIinteger\fR]   [\-\-\fBverbose\fR]  [\-\-\fBquiet\fR] 
.SS Flags:
.IP "\fB\-q\fR" 4m
.br
Quiet
.IP "\fB\-h\fR" 4m
.br
Suppress page headers
.IP "\fB\-f\fR" 4m
.br
Use formfeeds between pages
.IP "\fB\-e\fR" 4m
.br
Scientific format
.IP "\fB\-n\fR" 4m
.br
Filter out all no data cells
.IP "\fB\-N\fR" 4m
.br
Filter out cells where all maps have no data
.IP "\fB\-C\fR" 4m
.br
Report for cats fp ranges (fp maps only)
.IP "\fB\-i\fR" 4m
.br
Read fp map as integer (use map's quant rules)
.IP "\fB\-\-verbose\fR" 4m
.br
Verbose module output
.IP "\fB\-\-quiet\fR" 4m
.br
Quiet module output
.PP
.SS Parameters:
.IP "\fBmap\fR=\fIname[,\fIname\fR,...]\fR" 4m
.br
Raster map(s) to report on
.IP "\fBunits\fR=\fIstring[,\fIstring\fR,...]\fR" 4m
.br
Units
.br
Options: \fImi,me,k,a,h,c,p\fR
.br
\fBmi\fR: miles
.br
\fBme\fR: meters
.br
\fBk\fR: kilometers
.br
\fBa\fR: acres
.br
\fBh\fR: hectares
.br
\fBc\fR: cell counts
.br
\fBp\fR: percent cover
.IP "\fBnull\fR=\fIstring\fR" 4m
.br
Character representing no data cell value
.br
Default: \fI*\fR
.IP "\fBpl\fR=\fIinteger\fR" 4m
.br
Page length (default: 0 lines)
.IP "\fBpw\fR=\fIinteger\fR" 4m
.br
Page width (default: 79 characters)
.IP "\fBoutput\fR=\fIstring\fR" 4m
.br
Name of an output file to hold the report
.IP "\fBnsteps\fR=\fIinteger\fR" 4m
.br
Number of fp subranges to collect stats from
.br
Default: \fI255\fR
.PP
.SH DESCRIPTION
\fIr.report\fR allows the user to set up a series of report parameters to
be applied to a raster map layer, and creates a report.  If invoked with
command line arguments, the report will print out to the screen only.
However, output may be redirected to a file or another program using the
UNIX redirection mechanism. If invoked without command line arguments, the
user is given the option of printing out each report and/or saving output to
a file.
.PP
The report itself consists of two parts, a header section and the main body
of the report.
.PP
The header section of the report identifies the raster map layer(s) (by map
layer name and TITLE), location, mapset, report date, and the region of
interest. The area of interest is described in two parts: the user's current
geographic region is presented, and the mask is presented (if any is used).
.PP
The main body of the report consists of from one to three tables which
present the statistics for each category and the totals for each unit
column.
.PP
Note that, unlike \fIr.stats\fR,
\fIr.report\fR allows the user to select the specific units of measure in
which statistics will be reported.
.PP
Following is the result of a \fIr.report\fR run on the raster map layer
\fIgeology\fR (located in the Spearfish, SD sample data base), with the
units expressed in square miles and acres. Here, \fIr.report\fR output is
directed into the file \fIreport.file\fR.
.SH EXAMPLE:
\fBr.report map=\fR\fIgeology\fR \fBunits=\fR\fImiles,acres\fR > \fIreport.file \fR
.PP
\fC
.DS
.br
 ____________________________________________________________
.br
|                 RASTER MAP CATEGORY REPORT                 |
.br
| LOCATION: spearfish                      Fri Sep 2 09:20:09|
.br
|____________________________________________________________|
.br
|           north:   4928000.00   east:   609000.00          |
.br
| REGION:   south:   4914000.00   west:   590000.00          |
.br
|           res:         100.00   res:       100.00          |
.br
|____________________________________________________________|
.br
| MASK:     none                                             |
.br
|____________________________________________________________|
.br
| MAP:      geology in PERMANENT                             |
.br
|____________________________________________________________|
.br
|         Category Information     |    Acres       Square   |
.br
|    #      description            |                Miles    |
.br
|________|_________________________|_________________________|
.br
|    0   |  no data                |     415.13|      0.65   |
.br
|    1   |  metamorphic            |    2597.02|      4.06   |
.br
|    2   |  transition             |      32.12|      0.05   |
.br
|    3   |  igneous                |    8117.24|     12.68   |
.br
|    4   |  sandstone              |   16691.60|     26.08   |
.br
|    5   |  limestone              |   13681.93|     21.38   |
.br
|    6   |  shale                  |   10304.07|     16.10   |
.br
|    7   |  sandy shale            |    2517.95|      3.93   |
.br
|    8   |  claysand               |    3229.60|      5.05   |
.br
|    9   |  sand                   |    8141.95|     12.72   |
.br
|__________________________________|___________|_____________|
.br
|                 TOTAL            |   65728.60|    102.70   |
.br
|__________________________________|___________|_____________|
.br
.DE
\fR
.SH NOTES
If the user runs \fIr.report\fR interactively and saves the report output
in a file, this file will be placed into the user's current working
directory.
.PP
If the user runs \fIr.report\fR non-interactively, report output can be
saved by redirecting it to a file or a printer using the UNIX redirection
mechanism.
.PP
To output computer-friendly data suitable for importing into a spreadsheet
use the \fIr.stats\fR module. In fact \fIr.report\fR is running
\fIr.stats\fR in the background and reformatting the results to be
more human-friendly.
.SH SEE ALSO
\fIg.region,
r.coin,
r.describe,
r.info,
r.stats,
r.univar
\fR
.SH AUTHOR
Michael Shapiro,
U.S. Army Construction Engineering Research Laboratory
.PP
\fILast changed: $Date: 2013-04-18 14:21:53 +0200 (Thu, 18 Apr 2013) $\fR
.PP
Full index
.PP
© 2003-2014 GRASS Development Team