get_var_info {SticsRFiles}

Find STICS output variable names and description

Description

Helper function that returns names and descriptions of STICS output variables from a partial name and/or descriptive keywords.

Usage

get_var_info(var = NULL, keyword = NULL, stics_version = "latest")

Arguments

var

Vector of variable names (or partial names). Optional, if not provided, the function returns information for all variables.

keyword

Search by keyword instead of variable name (search in the name and description field)

stics_version

Name of the STICS version. Optional, can be used to search parameters information relative to a specific STICS version. By default the latest version returned by get_stics_versions_compat() is used.

Details

The function understand regex as input.

Value

A data.frame with information about variable(s) with columns name, definition, unit, type

Examples

# Find by variable name (fuzzy search):
SticsRFiles::get_var_info("lai")

# Find by keyword (fuzzy search in variable name and description):
SticsRFiles::get_var_info(keyword = "lai")

# Find for a particular version:
SticsRFiles::get_var_info("lai", stics_version = "V9.0")