hop_params: Display Hi-sAFe output variables

In kevinwolz/hisafer: An R Toolbox for the Hi-sAFe Biophysical Agroforestry Model

Description

Displays Hi-sAFe output variables, their definitions, and thier units.

Usage

hop_params(variables = "all", search = FALSE, quiet = FALSE)

Arguments

variables	A character vector of specific Hi-sAFe output variables of which to display details. Can also be a regular expression for which to search in Hi-sAFe output variable names. If "all", the default, then a data.frame (tibble) containing all Hi-sAFe output variables is returned.
search	Logical indicating whether variables should be treated as a regular expression and searched for in the variable names rather than matched literally.
quiet	Logical indicating whether or not to supress output printed to console.

Value

If variables is "all", the default, then a data.frame (tibble) containing all Hi-sAFe output variables is returned. Otherwise, this data.frame is invisibly returned.

See Also

Other hisafe helper functions: copy_hisafe_template(), get_pheno_dates(), get_pruning_dates(), hip_params(), hisafe_info(), hisafe_profiles(), hop_filter(), hop_merge(), hop_rename(), is_face(), is_hip(), is_hop(), join_profiles(), make_rel_years(), profile_check(), variable_check(), which_profiles()

Examples

## Not run: 
hop_params()                 # details of all variables
hop_params("carbonBranches") # details of cellWidth parameter

## End(Not run)

kevinwolz/hisafer documentation built on Oct. 19, 2020, 4:43 p.m.