Skip to content

Commit

Permalink
t.rast.boxplot manual: edit html tags for options and flags
Browse files Browse the repository at this point in the history
  • Loading branch information
veroandreo committed Apr 18, 2024
1 parent dd45cdd commit 4bf6277
Showing 1 changed file with 28 additions and 28 deletions.
56 changes: 28 additions & 28 deletions src/temporal/t.rast.boxplot/t.rast.boxplot.html
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ <h2>DESCRIPTION</h2>

<p>
The whiskers of the boxplots extend to the most extreme data point,
which is no more than <i>range</i> &#10005; the interquartile range
(iqr) from the box. By default, a <i>range</i> of 1.5 is used, but the
which is no more than <b>range</b> &#10005; the interquartile range
(iqr) from the box. By default, a <b>range</b> of 1.5 is used, but the
user can change this. Note that range values need to be larger than 0.

<p>
Expand All @@ -23,7 +23,7 @@ <h2>DESCRIPTION</h2>
two time-series of, e.g., two different areas.

<p>
There are various option to format the boxplots, e.g., setting the
There are various options to format the boxplots, e.g., setting the
width and color of the boxplots, the color and thickness of the median
line(s), whisker line width, and flier marker type and color.

Expand All @@ -35,57 +35,57 @@ <h2>DESCRIPTION</h2>
cheatsheet</a>.

<p>
Alternatively, the user can set the <i>-d flag</i>. With this option,
Alternatively, the user can set the <b>d</b> flag. With this option,
an attempt is made to figure out the best tick locations and format to
use, and to make the format as compact as possible while still having
complete date information. Note, this will override the
<i>data_format</i> setting. With this option, often not all boxplots
<b>data_format</b> setting. With this option, often not all boxplots
will get a label.

<p>
By default, the resulting plot is displayed on screen. However, the
user can also save the plot to file using the <em>output</em> option.
user can also save the plot to file using the <b>output</b> option.
The format is determined by the extension given by the user. So, if
output = outputfile.png, the plot will be saved as a *png* file. The
output = outputfile.png, the plot will be saved as a PNG file. The
user can set the output size (in inches) and resolution (dpi) of the
output image.

<h2>NOTE</h2>

If you work with a large number of raster layers, of if the raster
layers are very large, try to avoid setting the 'range' value very low,
If you work with a large number of raster layers, or if the raster
layers are very large, try to avoid setting the <b>range</b> value very low,
as that may result in a massive number of outliers, slowing down the
computations and rendering of the plot.

<p>
The t.rast.boxplot module operates on the raster array defined by the
The <em>t.rast.boxplot</em> module operates on the raster array defined by the
current region settings, not the original extent and resolution of the
input map. See <a
href="https://grass.osgeo.org/grass-stable/manuals/r.univar.html">g.region</a>
to understand the impact of the region settings on the calculations.

<p>
You can change the width of the boxplot using the <i>bx_width</i>
parameter. The default value is 0.75, which means that the boxplots
You can change the width of the boxplot using the <b>bx_width</b>
parameter. The default value is 0.75, which means that the boxplot is
0.75 the maximum width between two consecutive periods. Importantly,
the function uses the time stamp unit (see
<a href="https://grass.osgeo.org/grass-stable/manuals/t.register.html">
t.register</a>) to determine the maximum width. This means that if
the time stamp unit is in days, but the raster layers represent e.g.,
10-day periods, you need to multiply the <i>bx_width</i> value you would
10-day periods, you need to multiply the <b>bx_width</b> value you would
normally use by 10 to get the same relative width. See
<a href="https://ecodiv.earth/post/drawing-boxplots-of-raster-values/">
this post</a> for an example.

<h2>EXAMPLE</h2>

The first two examples use the MODIS Land Surface Temperature mapset.
First download the North Caroline sample data set from <a
First download the North Carolina sample data set from <a
href="https://grass.osgeo.org/download/data/#NorthCarolinaDataset">this
link</a>. Unzip the sample GRASS GIS dataset to a convenient location
on your computer. Next, download the MODIS mapset (<a
href="https://grass.osgeo.org/grass82/manuals/temporalintro.html">link</a>)
and unzip this in the NC location of the NC database. Now, open the
on your computer. Next, download the
<a href="https://grass.osgeo.org/sampledata/north_carolina/nc_spm_mapset_modis2015_2016_lst_grass8.zip">MODIS LST mapset</a>
and unzip it within the NC project. Now, open the
mapset in GRASS GIS.

<h3>Example 1</h3>
Expand All @@ -110,17 +110,17 @@ <h3>Example 2</h3>

We use the same example as above, but this time, we change the color of
the boxplots and median lines to respectively green
(<i>bx_color=green</i>) and white (<i>median_color=white</i>), use the
(<b>bx_color=green</b>) and white (<b>median_color=white</b>), use the
default plot dimensions, set the font size to 8, and include the
outliers (<i>-o flag</i>). Note that by plotting the outliers will
outliers (<b>o</b> flag). Note that by plotting the outliers will
increase the time required to create the plot considerably.

<p>
For the outliers (fliers) we use orange squares (<i>flier_marker=s</i>
& <i>flier_color=orange</i>). We furthermore plot the boxplots
horizontally (<i>-h flag</i>) and add grid lines (<i>-g flag</i>. Note
For the outliers (fliers) we use orange squares (<b>flier_marker=s</b>
& <b>flier_color=orange</b>). We furthermore plot the boxplots
horizontally (<b>h</b> flag) and add grid lines (<b>g</b> flag). Note
that for horizontal plots, the labels are plotted horizontally (equal
to rotate_labels=0) by default.
to <b>rotate_labels=0</b>) by default.

<p>
<div class="code"><pre>
Expand All @@ -142,11 +142,11 @@ <h3>Example 2</h3>
<h3>Example 3</h3>

In the following example, the date labels are changed, showing the
abbreviated name of the month, followed by the year (<i>date_format="%B
%Y"</i>). The boxplot colors are set to white, and for the median line
abbreviated name of the month, followed by the year (<b>date_format="%B
%Y"</b>). The boxplot colors are set to white, and for the median line
we set the color to orange and the line width to 2. Lastly, the labels
are rotated 90&#8451; (the default for vertical plots is
rotate_labels=45).
<b>rotate_labels=45</b>).

<p>
<div class="code"><pre>
Expand Down Expand Up @@ -203,8 +203,8 @@ <h2>Acknowledgements</h2>
<h2>SEE ALSO</h2>

<em>
<a href="https://grass.osgeo.org/grass-stable/manuals/addons/r.boxplot.html">r.boxplot.html</a>,
<a href="https://grass.osgeo.org/grass-stable/manuals/addons/r.series.boxplot.html">r.series.boxplot.html</a>,
<a href="https://grass.osgeo.org/grass-stable/manuals/addons/r.boxplot.html">r.boxplot</a>,
<a href="https://grass.osgeo.org/grass-stable/manuals/addons/r.series.boxplot.html">r.series.boxplot</a>,
<a href="https://grass.osgeo.org/grass-stable/manuals/addons/d.vect.colbp.html">d.vect.colbp</a>,
<a href="https://grass.osgeo.org/grass-stable/manuals/addons/r.scatterplot.html">r.scatterplot</a>,
<a href="https://grass.osgeo.org/grass-stable/manuals/r.stats.zonal.html">r.stats.zonal</a>,
Expand Down

0 comments on commit 4bf6277

Please sign in to comment.