check_bankline_points: Check the validity of an 'fluvgeo' 'bankline_points' data...

View source: R/check_bankline_points.R

check_bankline_pointsR Documentation

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

Description

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

Usage

check_bankline_points(bankline_points)

Arguments

bankline_points

sf; a 'bankline_points' data structure used by the fluvgeo package.

Value

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