hip_params: Display supported Hi-sAFe input parameters

Description Usage Arguments Value See Also Examples

View source: R/misc.R

Description

Displays supported Hi-sAFe input parameters, their default values, and their accepted/suggested ranges.

Usage

1
hip_params(params = "all", search = FALSE, template = "agroforestry")

Arguments

params

A character vector of specific Hi-sAFe input parameters of which to display details. Can also be a regular expression for which to search in Hi-sAFe parameter names. If "all", the default, then a data.frame (tibble) containing all Hi-sAFe input parameters is returned.

search

Logical indicating whether params should be treated as a regular expression and searched for in the parameter names rather than matched literally.

template

A character string of the path to the directory containing the template set of Hi-sAFe simulation folders/files to use. hisafer comes with a variety of "default" templates than can be used by specificying specific character strings. See define_hisafe for details.

Value

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

See Also

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

Examples

1
2
3
4
5
6
## Not run: 
hip_params()              # details of all parameters
hip_params("cellWidth")   # details of cellWidth parameter
hip_params("paramShape1") # input parameters within tables are also accepted

## End(Not run)

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