calc_catchment_attributes_rast_rec: calc_catchment_attributes_rast_rec Aggregate attributes for...
In openSTARS: An Open Source Implementation of the 'ArcGIS' Toolbox 'STARS'
Description
Usage
Arguments
Value
Note
Description
Recursive function to calculate the catchment attributes of each stream
segment. It is called by calc_catchment_attributes_rast for each
outlet and should not be called by the user.
Usage
1
calc_catchment_attributes_rast_rec(dt, id, stat, attr_name)
Arguments
dt
data.table of stream topology and attributes per segment.
id
integer; 'stream' of outlet segment to start the calculation from.
stat
name or character vector giving the statistics to be calculated,
must be one of: min, max, mean, percent.
attr_name
name or character vector of column names for the attribute(s)
to be calculated.
Value
One row data.table with the cumulative number of cells of the total
catchment of each segment and the values for each attribute and changes the
values in dt.
Note
The values for stats "mean" and "percent" need to be divided by the cumulative
number of cells of the total catchment in a subsequent step.
openSTARS documentation built on Feb. 4, 2022, 5:08 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Description Usage Arguments Value Note
Description
Recursive function to calculate the catchment attributes of each stream
segment. It is called by calc_catchment_attributes_rast for each
outlet and should not be called by the user.
Usage
1 | calc_catchment_attributes_rast_rec(dt, id, stat, attr_name)
|
Arguments
dt |
data.table of stream topology and attributes per segment. |
id |
integer; 'stream' of outlet segment to start the calculation from. |
stat |
name or character vector giving the statistics to be calculated, must be one of: min, max, mean, percent. |
attr_name |
name or character vector of column names for the attribute(s) to be calculated. |
Value
One row data.table with the cumulative number of cells of the total catchment of each segment and the values for each attribute and changes the values in dt.
Note
The values for stats "mean" and "percent" need to be divided by the cumulative number of cells of the total catchment in a subsequent step.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.