check_xs_dims: Check the validity of an 'fluvgeo' 'xs_dims' data structure
In FluvialGeomorph/fluvgeo: A Package for Fluvial Geomorphic Analysis
View source: R/check_xs_dims.R
check_xs_dims R Documentation
Check the validity of an 'fluvgeo' 'xs_dims' data structure
Description
Checks that the input data structure 'xs_dims' meets
the requirements for this data structure.
Usage
check_xs_dims(xs_dims)
Arguments
xs_dims
data frame; a 'xs_dims' data structure used
by the fluvgeo package.
Value
Returns TRUE if the 'xs_dims' data structure 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_xs_dims.R
| check_xs_dims | R Documentation |
Check the validity of an 'fluvgeo' 'xs_dims' data structure
Description
Checks that the input data structure 'xs_dims' meets the requirements for this data structure.
Usage
check_xs_dims(xs_dims)
Arguments
xs_dims |
data frame; a 'xs_dims' data structure used by the fluvgeo package. |
Value
Returns TRUE if the 'xs_dims' data structure 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.