check_cross_section: Check the validity of an 'fluvgeo' 'cross_section' data...

In FluvialGeomorph/fluvgeo: A Package for Fluvial Geomorphic Analysis

Check the validity of an 'fluvgeo' 'cross_section' data structure

Description

Checks that the input data structure 'cross_section' meets the requirements for this data structure.

Usage

check_cross_section(
  cross_section,
  step = c("assign_ids", "watershed_area", "river_position", "station_points",
    "loop_bend")
)

Arguments

cross_section	SpatialLinesDataFrame of sf: a 'cross_section' data structure used by the fluvgeo package.
step	character; last completed processing step. One of "assign_ids", "watershed_area", "river_position", "station_points", "loop_bend"

Details

Cross section feature classes evolve as different steps are performed on them. The 'step' parameter allows a 'cross section' data structure to be checked throughout its lifecycle. Each step defines a changing set of requirements for the 'cross section' data structure.

Value

Returns TRUE if the 'cross_section' 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.