check_slope_sinuosity: Check the validity of the 'slope_sinuosity' function
In FluvialGeomorph/fluvgeo: A Package for Fluvial Geomorphic Analysis
View source: R/check_slope_sinuosity.R
check_slope_sinuosity R Documentation
Check the validity of the 'slope_sinuosity' function
Description
Checks that the output of the 'slope_sinuosity' function is
valid.
Usage
check_slope_sinuosity(slope_sinuosity_df)
Arguments
slope_sinuosity_df
data frame; a data frame produced by the
'slope_sinousity' functionv.
Value
Returns TRUE if the 'slope_sinuosity_df' data frame matches the
requirements. The function throws an error for a data structure not matching
the data specification. Returns errors describing how the the data structure
doesn't match the requirement.
FluvialGeomorph/fluvgeo documentation built on April 12, 2024, 5:35 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.
View source: R/check_slope_sinuosity.R
| check_slope_sinuosity | R Documentation |
Check the validity of the 'slope_sinuosity' function
Description
Checks that the output of the 'slope_sinuosity' function is valid.
Usage
check_slope_sinuosity(slope_sinuosity_df)
Arguments
slope_sinuosity_df |
data frame; a data frame produced by the 'slope_sinousity' functionv. |
Value
Returns TRUE if the 'slope_sinuosity_df' data frame matches the requirements. The function throws an error for a data structure not matching the data specification. Returns errors describing how the the data structure doesn't match the requirement.
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.