check_cross_section_points: Check the validity of an 'fluvgeo' 'cross_section_points'...
In FluvialGeomorph/fluvgeo: A Package for Fluvial Geomorphic Analysis
View source: R/check_cross_section_points.R
check_cross_section_points R Documentation
Check the validity of an 'fluvgeo' 'cross_section_points' data structure
Description
Checks that the input data structure 'cross_section_points'
meets the requirements for this data structure.
Usage
check_cross_section_points(xs_points, step = c("station_points", "loop_bend"))
Arguments
xs_points
sf; a 'cross_section_points'
data structure used by the fluvgeo package.
step
character; last completed processing step. One of
"station_points", "loop_bend"
Value
Returns TRUE if the 'cross_section_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_cross_section_points.R
| check_cross_section_points | R Documentation |
Check the validity of an 'fluvgeo' 'cross_section_points' data structure
Description
Checks that the input data structure 'cross_section_points' meets the requirements for this data structure.
Usage
check_cross_section_points(xs_points, step = c("station_points", "loop_bend"))
Arguments
xs_points |
sf; a 'cross_section_points' data structure used by the fluvgeo package. |
step |
character; last completed processing step. One of "station_points", "loop_bend" |
Value
Returns TRUE if the 'cross_section_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.