get_variable_def {allometric}R Documentation

Get the definition of a variable in the variable naming system.

Description

When possible, variables are given standard names using the variable naming system. The definitions for a variable can be found using this function. The search_str argument works using partial matching of the beginning of each variable name. For example input "d" will return all diameter definitions but input "dsob" will only return the definition for diameter outside bark at breast height.

Usage

get_variable_def(search_str, return_exact_only = FALSE)

Arguments

search_str

The string to search with.

return_exact_only

Some variables are completely defined but will return "addditional" matches. For example, "hst" refers to the total height of a tree, but "hstix" refers to a site index. If this argument is false, all strings starting with "hst" will be returned. If true, then only "hst" will be returned.

Value

A data.frame containing the matched variable definitions.


[Package allometric version 2.1.0 Index]