1r.report(1)                 GRASS GIS User's Manual                r.report(1)
2
3
4

NAME

6       r.report  - Reports statistics for raster maps.
7

KEYWORDS

9       raster, statistics
10

SYNOPSIS

12       r.report
13       r.report --help
14       r.report  [-hfenaci]  map=name[,name,...]   [units=string[,string,...]]
15       [output=name]         [null_value=string]         [page_length=integer]
16       [page_width=integer]   [nsteps=integer]   [sort=string]   [--overwrite]
17       [--help]  [--verbose]  [--quiet]  [--ui]
18
19   Flags:
20       -h
21           Suppress page headers
22
23       -f
24           Use formfeeds between pages
25
26       -e
27           Scientific format
28
29       -n
30           Do not report no data value
31
32       -a
33           Do not report cells where all maps have no data
34
35       -c
36           Report for cats floating-point ranges (floating-point maps only)
37
38       -i
39           Read floating-point map as integer (use map’s quant rules)
40
41       --overwrite
42           Allow output files to overwrite existing files
43
44       --help
45           Print usage summary
46
47       --verbose
48           Verbose module output
49
50       --quiet
51           Quiet module output
52
53       --ui
54           Force launching GUI dialog
55
56   Parameters:
57       map=name[,name,...] [required]
58           Name of raster map(s) to report on
59
60       units=string[,string,...]
61           Units to report
62           Options: mi, me, k, a, h, c, p
63           mi: area in square miles
64           me: area in square meters
65           k: area in square kilometers
66           a: area in acres
67           h: area in hectares
68           c: number of cells
69           p: percent cover
70
71       output=name
72           Name for output file to hold the report
73           If no output file given report is printed to standard output
74
75       null_value=string
76           String representing NULL value
77           Default: *
78
79       page_length=integer
80           Page length
81           Default: 0
82
83       page_width=integer
84           Page width
85           Default: 79
86
87       nsteps=integer
88           Number of floating-point subranges to collect stats from
89           Default: 255
90
91       sort=string
92           Sort output statistics by cell counts
93           Default: sorted by categories or intervals
94           Options: asc, desc
95           asc: Sort by cell counts in ascending order
96           desc: Sort by cell counts in descending order
97

DESCRIPTION

99       r.report allows the user to set up a series of report parameters to  be
100       applied  to  a  raster map, and creates a report. The report will print
101       out to the standard output if output parameter is not given.
102
103       The report itself consists of two parts, a header section and the  main
104       body of the report.
105
106       The  header  section of the report identifies the raster map(s) (by map
107       name and title), location, mapset,  report  date,  and  the  region  of
108       interest.  The  area  of interest is described in two parts: the user’s
109       current geographic region is presented, and the mask is  presented  (if
110       any is used).
111
112       The  main body of the report consists of from one to three tables which
113       present the statistics for each category and the totals for  each  unit
114       column. Note that the statistics is always computed in the current geo‐
115       graphical region.
116
117       When multiple (typically two) raster maps are specified,  cross-tabula‐
118       tion  table  for each combination of categories in the raster maps will
119       be computed and formatted in a human-readable way (see example).
120

NOTES

122       Note that, unlike r.stats, r.report allows the user to select the  spe‐
123       cific  units of measure in which statistics will be reported. To output
124       computer-friendly data suitable for importing into  a  spreadsheet  use
125       the  r.stats  module.  In fact r.report is running r.stats in the back‐
126       ground and reformatting the results to be more human-friendly.
127

EXAMPLE

129       Report sorted areas in  square  miles  and  acres  for  each  category.
130       No-data are not reported (see -n flag).
131       r.report -n map=geology_30m units=mi,a sort=desc
132       +-----------------------------------------------------------------------------+
133       |                         RASTER MAP CATEGORY REPORT                          |
134       |LOCATION: nc_spm_08_grass7                           Fri Dec  6 17:00:21 2013|
135       |-----------------------------------------------------------------------------|
136       |          north: 279073.97546639    east: 798143.31179672                    |
137       |REGION    south: 113673.97546639    west: 595143.31179672                    |
138       |          res:               200    res:              200                    |
139       |-----------------------------------------------------------------------------|
140       |MASK: none                                                                   |
141       |-----------------------------------------------------------------------------|
142       |MAP: South-West Wake county: geology derived from vector map (geology_30m in |
143       |-----------------------------------------------------------------------------|
144       |                 Category Information                  |    square|          |
145       |  #|description                                        |     miles|     acres|
146       |-----------------------------------------------------------------------------|
147       |217|CZfg . . . . . . . . . . . . . . . . . . . . . . . | 27.783911|17,781.703|
148       |270|CZig . . . . . . . . . . . . . . . . . . . . . . . | 26.162282|16,743.861|
149       |405|CZbg . . . . . . . . . . . . . . . . . . . . . . . |  9.698886|  6207.287|
150       |262|CZlg . . . . . . . . . . . . . . . . . . . . . . . |  7.629379|  4882.802|
151       |862|CZam . . . . . . . . . . . . . . . . . . . . . . . |  2.532830|  1621.011|
152       |910|CZbg . . . . . . . . . . . . . . . . . . . . . . . |  1.683405|  1077.379|
153       |583|CZve . . . . . . . . . . . . . . . . . . . . . . . |  0.972977|   622.706|
154       |921|Km . . . . . . . . . . . . . . . . . . . . . . . . |  0.463323|   296.526|
155       |766|CZg. . . . . . . . . . . . . . . . . . . . . . . . |  0.324326|   207.569|
156       |720|CZam . . . . . . . . . . . . . . . . . . . . . . . |  0.185329|   118.611|
157       |946|CZam . . . . . . . . . . . . . . . . . . . . . . . |  0.138997|    88.958|
158       |948|CZam . . . . . . . . . . . . . . . . . . . . . . . |  0.030888|    19.768|
159       |-----------------------------------------------------------------------------|
160       |TOTAL                                                  | 77.606534|49,668.182|
161       +-----------------------------------------------------------------------------+
162       Report  areas  for each category of land use for each zipcode (included
163       only part of the table):
164       r.report map=zipcodes@PERMANENT,landclass96@PERMANENT units=h,p
165       +-----------------------------------------------------------------------------+
166       |                         RASTER MAP CATEGORY REPORT                          |
167       |LOCATION: nc_spm_08_latest                           Tue Feb 11 10:10:46 2014|
168       |-----------------------------------------------------------------------------|
169       |          north: 228527.25    east: 644971                                   |
170       |REGION    south: 215018.25    west: 629980                                   |
171       |          res:        28.5    res:    28.5                                   |
172       |-----------------------------------------------------------------------------|
173       |MASK: none                                                                   |
174       |-----------------------------------------------------------------------------|
175       |MAPS: South West Wake: Zipcode areas derived from vector map (zipcodes@PERMAN|
176       |        South-West Wake county: Simplified landuse classes (landclass96@PERMA|
177       |-----------------------------------------------------------------------------|
178       |                   Category Information                    |          |   %  |
179       |    #|description                                          |  hectares| cover|
180       |-----------------------------------------------------------------------------|
181       |27511|CARY                                                 |  1053.813|  5.20|
182       |     |-----------------------------------------------------|----------|------|
183       |     |1|developed. . . . . . . . . . . . . . . . . . . . . |   197.214| 18.71|
184       |     |3|herbaceous . . . . . . . . . . . . . . . . . . . . |    25.017|  2.37|
185       |     |4|shrubland. . . . . . . . . . . . . . . . . . . . . |    58.563|  5.56|
186       |     |5|forest . . . . . . . . . . . . . . . . . . . . . . |   771.313| 73.19|
187       |     |6|water. . . . . . . . . . . . . . . . . . . . . . . |     1.625|  0.15|
188       |     |*|no data. . . . . . . . . . . . . . . . . . . . . . |     0.081|  0.01|
189       |-----------------------------------------------------------|----------|------|
190       |27513|CARY                                                 |   204.525|  1.01|
191       |     |-----------------------------------------------------|----------|------|
192       |     |1|developed. . . . . . . . . . . . . . . . . . . . . |    32.571| 15.93|
193       |     |3|herbaceous . . . . . . . . . . . . . . . . . . . . |     6.011|  2.94|
194       |     |4|shrubland. . . . . . . . . . . . . . . . . . . . . |    51.659| 25.26|
195       |     |5|forest . . . . . . . . . . . . . . . . . . . . . . |   114.284| 55.88|
196       |-----------------------------------------------------------|----------|------|
197       ...
198       |-----------------------------------------------------------------------------|
199       |TOTAL                                                      |22,968.900|100.00|
200       +-----------------------------------------------------------------------------+
201

SEE ALSO

203        r.stats, g.region, r.coin, r.describe, r.info, r.univar
204

AUTHORS

206       Michael Shapiro, U.S. Army Construction Engineering Research Laboratory
207       Sort option by Martin Landa, Czech Technical University in Prague, 2013
208

SOURCE CODE

210       Available at: r.report source code (history)
211
212       Main index | Raster index | Topics index | Keywords index  |  Graphical
213       index | Full index
214
215       © 2003-2020 GRASS Development Team, GRASS GIS 7.8.5 Reference Manual
216
217
218
219GRASS 7.8.5                                                        r.report(1)
Impressum