wbt_ruggedness_index

Calculates the Riley et al.'s (1999) terrain ruggedness index from an input DEM.

An R frontend for the 'WhiteboxTools' library, which is an advanced geospatial data analysis platform developed by Prof. John Lindsay at the University of Guelph's Geomorphometry and Hydrogeomatics Research Group. 'WhiteboxTools' can be used to perform common geographical information systems (GIS) analysis operations, such as cost-distance analysis, distance buffering, and raster reclassification. Remote sensing and image processing tasks include image enhancement (e.g. panchromatic sharpening, contrast adjustments), image mosaicing, numerous filtering operations, simple classification (k-means), and common image transformations. 'WhiteboxTools' also contains advanced tooling for spatial hydrological analysis (e.g. flow-accumulation, watershed delineation, stream network analysis, sink removal), terrain analysis (e.g. common terrain indices such as slope, curvatures, wetness index, hillshading; hypsometric analysis; multi-scale topographic position analysis), and LiDAR data processing. Suggested citation: Lindsay (2016) <doi:10.1016/j.cageo.2016.07.003>.

Andrew Brown

whitebox

'WhiteboxTools' R Frontend

Qiusheng Wu

wbt_ruggedness_index function

<dl><dt>dem</dt>
<dd>Input raster DEM file.</dd>
<dt>output</dt>
<dd>Output raster file.</dd>
<dt>zfactor</dt>
<dd>Optional multiplier for when the vertical and horizontal units are not the same.</dd>
<dt>wd</dt>
<dd>Changes the working directory.</dd>
<dt>verbose_mode</dt>
<dd>Sets verbose mode. If verbose mode is <code>FALSE</code>, tools will not print output messages.</dd>
<dt>compress_rasters</dt>
<dd>Sets the flag used by WhiteboxTools to determine whether to use compression for output rasters.</dd>
<dt>command_only</dt>
<dd>Return command that would be executed by <code><a href="/link/system()?package=whitebox&version=2.1.5" data-mini-rdoc="whitebox::system()">system()</a></code> rather than running tool.</dd></dl>

Arguments

Ruggedness index — wbt_ruggedness_index

<dl>

<dt>dem</dt>
<dd>Input raster DEM file.</dd>


<dt>output</dt>
<dd>Output raster file.</dd>


<dt>zfactor</dt>
<dd>Optional multiplier for when the vertical and horizontal units are not the same.</dd>


<dt>wd</dt>
<dd>Changes the working directory.</dd>


<dt>verbose_mode</dt>
<dd>Sets verbose mode. If verbose mode is <code>FALSE</code>, tools will not print output messages.</dd>


<dt>compress_rasters</dt>
<dd>Sets the flag used by WhiteboxTools to determine whether to use compression for output rasters.</dd>


<dt>command_only</dt>
<dd>Return command that would be executed by <code><a href='https://rdrr.io/r/base/system.html'>system()</a></code> rather than running tool.</dd>

</dl>

wbt_ruggedness_index: Ruggedness index

Description

Usage

Value

Arguments