validate_fe_ccircle_spatial: Validate an *fe_ccircle_spatial* Object

In ForestElementsR: Data Structures and Functions for Working with Forest Data

Validate an fe_ccircle_spatial Object

Description

Regular users will not require this function. Expert users will want to use it in combination with the constructor new_fe_ccircle_spatial. Regular users, please construct fe_ccircle_spatial objects with fe_ccircle_spatial.

Usage

validate_fe_ccircle_spatial(x, method = c("strict", "flexible"))

Arguments

x	An object that is expected to be a correct fe_ccircle_spatial object
method	Character string that specifies whether tree_positions is allowed to contain less tree_ids than trees (i.e. in this case, not all trees have coordinates). Possible choices are "strict" (default) and "flexible". If method == "flexible", a warning is issued if not all trees have coordinates. If method == "strict", the validation terminates with an error.

Value

Returns x, but this function is mainly called for its side effect which is pointing out any violations of the fe_ccircle_spatial object specifications. In case of such violations, the function will terminate with an error.

Examples

  # Validate the example fe_ccircle_spatial object
  spruce_pine_ccircle_spatial |>
    validate_fe_ccircle_spatial(method = "flexible")

ForestElementsR documentation built on April 3, 2025, 7:47 p.m.