check_flowline: Check the validity of an 'fluvgeo' 'flowline' data structure

In FluvialGeomorph/fluvgeo: A Package for Fluvial Geomorphic Analysis

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

Description

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

Usage

check_flowline(flowline, step = c("create_flowline", "profile_points"))

Arguments

flowline	sf: a 'flowline' data structure used by the fluvgeo package.
step	character; last completed processing step. One of "create_flowline", "profile_points"

Value

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