check_channel_feature: Check the validity of an 'fluvgeo' 'channel_feature' data...

View source: R/check_channel_feature.R

check_channel_featureR Documentation

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

Description

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

Usage

check_channel_feature(channel_feature)

Arguments

channel_feature

data frame; a 'channel_feature' data structure used by the fluvgeo package.

Value

Returns TRUE if the 'channel_feature' 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 Feb. 19, 2025, 4:24 p.m.