basinStats: Gets statistics of .asc file of a basin

In KevinShook/WDPMr: Post-processing for the WDPM and PCM models

Gets statistics of .asc file of a basin

Description

Returns the statistics describing a basin contained in an ArcGIS .asc file, either a DEM or a water layer. The points outside the basin must be coded as missing.

Usage

basinStats(asc_file)

Arguments

asc_file

Required. A text .asc file describing a basin, as used by WDPM.

Value

If successful, returns a vector containing the following values

num_rows

Number of rows in the file

num_cols

Number of cols in the file

cell_size

Width of each cell. Typically in metres, could be in degrees

outside_cells

Number of cells outside the basin

inside_cells

Number of cells inside the basin

inside_area

Basin area in units of cell_size squared

Examples

## Not run: 
stats <- basinStats("StDenis.asc")

## End(Not run)

KevinShook/WDPMr documentation built on April 23, 2022, 12:32 a.m.