check_loop_points: Check the validity of an 'fluvgeo' 'loop_points' data...
In FluvialGeomorph/fluvgeo: A Package for Fluvial Geomorphic Analysis
View source: R/check_loop_points.R
check_loop_points R Documentation
Check the validity of an 'fluvgeo' 'loop_points' data structure
Description
Checks that the input data structure 'loop_points' meets
the requirements for this data structure.
Usage
check_loop_points(loop_points)
Arguments
loop_points
sf object; a 'loop_points' data structure
used by the fluvgeo package.
Details
Cross section feature classes evolve as different steps are
performed on them. The 'step' parameter allows a 'loop_points' data
structure to be checked throughout its lifecycle. Each step defines a
changing set of requirements for the 'loop_points' data structure.
Value
Returns TRUE if the 'loop_points' 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_loop_points.R
| check_loop_points | R Documentation |
Check the validity of an 'fluvgeo' 'loop_points' data structure
Description
Checks that the input data structure 'loop_points' meets the requirements for this data structure.
Usage
check_loop_points(loop_points)
Arguments
loop_points |
sf object; a 'loop_points' data structure used by the fluvgeo package. |
Details
Cross section feature classes evolve as different steps are performed on them. The 'step' parameter allows a 'loop_points' data structure to be checked throughout its lifecycle. Each step defines a changing set of requirements for the 'loop_points' data structure.
Value
Returns TRUE if the 'loop_points' 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.