1r.report(1) GRASS GIS User's Manual r.report(1)
2
6 r.report - Reports statistics for raster maps.
7
9 raster, statistics
10
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 Flags:
20 -h
21 Suppress page headers
22 -f
24 Use formfeeds between pages
25 -e
27 Scientific format
28 -n
30 Do not report no data value
31 -a
33 Do not report cells where all maps have no data
34 -c
36 Report for cats floating-point ranges (floating-point maps only)
37 -i
39 Read floating-point map as integer (use map’s quant rules)
40 --overwrite
42 Allow output files to overwrite existing files
43 --help
45 Print usage summary
46 --verbose
48 Verbose module output
49 --quiet
51 Quiet module output
52 --ui
54 Force launching GUI dialog
55 Parameters:
57 map=name[,name,...]Â [required]
58 Name of raster map(s) to report on
59 units=string[,string,...]
61 Units to report
62 Options: miles, meters, kilometers, acres, hectares, cells, percent
63 Default: cells,percent
64 miles: area in square miles
65 meters: area in square meters
66 kilometers: area in square kilometers
67 acres: area in acres
68 hectares: area in hectares
69 cells: number of cells
70 percent: percent cover
71 output=name
73 Name for output file to hold the report
74 If no output file given report is printed to standard output
75 null_value=string
77 String representing NULL value
78 Default: *
79 page_length=integer
81 Page length
82 Default: 0
83 page_width=integer
85 Page width
86 Default: 79
87 nsteps=integer
89 Number of floating-point subranges to collect stats from
90 Default: 255
91 sort=string
93 Sort output statistics by cell counts
94 Default: sorted by categories or intervals
95 Options: asc, desc
96 asc: Sort by cell counts in ascending order
97 desc: Sort by cell counts in descending order
98
100 r.report allows the user to set up a series of report parameters to be
101 applied to a raster map, and creates a report. The report will print
102 out to the standard output if output parameter is not given.
103 The report itself consists of two parts, a header section and the main
105 body of the report.
106 The header section of the report identifies the raster map(s) (by map
108 name and title), location, mapset, report date, and the region of in‐
109 terest. The area of interest is described in two parts: the user’s cur‐
110 rent geographic region is presented, and the mask is presented (if any
111 is used).
112 The main body of the report consists of from one to three tables which
114 present the statistics for each category and the totals for each unit
115 column. Note that the statistics is always computed in the current geo‐
116 graphical region.
117 When multiple (typically two) raster maps are specified, cross-tabula‐
119 tion table for each combination of categories in the raster maps will
120 be computed and formatted in a human-readable way (see example).
121
123 Note that, unlike r.stats, r.report allows the user to select the spe‐
124 cific units of measure in which statistics will be reported. To output
125 computer-friendly data suitable for importing into a spreadsheet use
126 the r.stats module. In fact r.report is running r.stats in the back‐
127 ground and reformatting the results to be more human-friendly.
128
130 Report sorted areas in square miles and acres for each category.
131 No-data are not reported (see -n flag).
132 r.report -n map=geology_30m units=mi,a sort=desc
133 +-----------------------------------------------------------------------------+
134 | RASTER MAP CATEGORY REPORT |
135 |LOCATION: nc_spm_08_grass7 Fri Dec 6 17:00:21 2013|
136 |-----------------------------------------------------------------------------|
137 | north: 279073.97546639 east: 798143.31179672 |
138 |REGION south: 113673.97546639 west: 595143.31179672 |
139 | res: 200 res: 200 |
140 |-----------------------------------------------------------------------------|
141 |MASK: none |
142 |-----------------------------------------------------------------------------|
143 |MAP: South-West Wake county: geology derived from vector map (geology_30m in |
144 |-----------------------------------------------------------------------------|
145 | Category Information | square| |
146 | #|description | miles| acres|
147 |-----------------------------------------------------------------------------|
148 |217|CZfg . . . . . . . . . . . . . . . . . . . . . . . | 27.783911|17,781.703|
149 |270|CZig . . . . . . . . . . . . . . . . . . . . . . . | 26.162282|16,743.861|
150 |405|CZbg . . . . . . . . . . . . . . . . . . . . . . . | 9.698886| 6207.287|
151 |262|CZlg . . . . . . . . . . . . . . . . . . . . . . . | 7.629379| 4882.802|
152 |862|CZam . . . . . . . . . . . . . . . . . . . . . . . | 2.532830| 1621.011|
153 |910|CZbg . . . . . . . . . . . . . . . . . . . . . . . | 1.683405| 1077.379|
154 |583|CZve . . . . . . . . . . . . . . . . . . . . . . . | 0.972977| 622.706|
155 |921|Km . . . . . . . . . . . . . . . . . . . . . . . . | 0.463323| 296.526|
156 |766|CZg. . . . . . . . . . . . . . . . . . . . . . . . | 0.324326| 207.569|
157 |720|CZam . . . . . . . . . . . . . . . . . . . . . . . | 0.185329| 118.611|
158 |946|CZam . . . . . . . . . . . . . . . . . . . . . . . | 0.138997| 88.958|
159 |948|CZam . . . . . . . . . . . . . . . . . . . . . . . | 0.030888| 19.768|
160 |-----------------------------------------------------------------------------|
161 |TOTAL | 77.606534|49,668.182|
162 +-----------------------------------------------------------------------------+
163 Report areas for each category of land use for each zipcode (included
164 only part of the table):
165 r.report map=zipcodes@PERMANENT,landclass96@PERMANENT units=h,p
166 +-----------------------------------------------------------------------------+
167 | RASTER MAP CATEGORY REPORT |
168 |LOCATION: nc_spm_08_latest Tue Feb 11 10:10:46 2014|
169 |-----------------------------------------------------------------------------|
170 | north: 228527.25 east: 644971 |
171 |REGION south: 215018.25 west: 629980 |
172 | res: 28.5 res: 28.5 |
173 |-----------------------------------------------------------------------------|
174 |MASK: none |
175 |-----------------------------------------------------------------------------|
176 |MAPS: South West Wake: Zipcode areas derived from vector map (zipcodes@PERMAN|
177 | South-West Wake county: Simplified landuse classes (landclass96@PERMA|
178 |-----------------------------------------------------------------------------|
179 | Category Information | | % |
180 | #|description | hectares| cover|
181 |-----------------------------------------------------------------------------|
182 |27511|CARY | 1053.813| 5.20|
183 | |-----------------------------------------------------|----------|------|
184 | |1|developed. . . . . . . . . . . . . . . . . . . . . | 197.214| 18.71|
185 | |3|herbaceous . . . . . . . . . . . . . . . . . . . . | 25.017| 2.37|
186 | |4|shrubland. . . . . . . . . . . . . . . . . . . . . | 58.563| 5.56|
187 | |5|forest . . . . . . . . . . . . . . . . . . . . . . | 771.313| 73.19|
188 | |6|water. . . . . . . . . . . . . . . . . . . . . . . | 1.625| 0.15|
189 | |*|no data. . . . . . . . . . . . . . . . . . . . . . | 0.081| 0.01|
190 |-----------------------------------------------------------|----------|------|
191 |27513|CARY | 204.525| 1.01|
192 | |-----------------------------------------------------|----------|------|
193 | |1|developed. . . . . . . . . . . . . . . . . . . . . | 32.571| 15.93|
194 | |3|herbaceous . . . . . . . . . . . . . . . . . . . . | 6.011| 2.94|
195 | |4|shrubland. . . . . . . . . . . . . . . . . . . . . | 51.659| 25.26|
196 | |5|forest . . . . . . . . . . . . . . . . . . . . . . | 114.284| 55.88|
197 |-----------------------------------------------------------|----------|------|
198 ...
199 |-----------------------------------------------------------------------------|
200 |TOTAL |22,968.900|100.00|
201 +-----------------------------------------------------------------------------+
202
204 r.stats, g.region, r.coin, r.describe, r.info, r.univar
205
207 Michael Shapiro, U.S. Army Construction Engineering Research Laboratory
208 Sort option by Martin Landa, Czech Technical University in Prague, 2013
209
211 Available at: r.report source code (history)
212 Accessed: Mon Jun 20 16:46:24 2022
214 Main index | Raster index | Topics index | Keywords index | Graphical
216 index | Full index
217 © 2003-2022 GRASS Development Team, GRASS GIS 8.2.0 Reference Manual
219GRASS 8.2.0 r.report(1)