get_param_info | R Documentation |
Helper function that returns names and descriptions of STICS input parameters from a partial name and/or descriptive keywords.
get_param_info(param = NULL, keyword = NULL, stics_version = "latest")
param |
Vector of parameter names (or partial names). Optional, if not provided, the function returns information for all parameters |
keyword |
Optional, strings or a vector of to be used for searching in parameters names and definition |
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 |
The function understand regex
as input.
A data.frame with information about parameter(s) with columns
name
,file
,min
,max
, definition
# Find by parameter name (fuzzy search):
SticsRFiles::get_param_info("alb")
SticsRFiles::get_param_info("alb[e]?")
# Find by keyword (fuzzy search in parameter name and description):
SticsRFiles::get_param_info(keyword = "bdil")
# Find for a particular version:
SticsRFiles::get_param_info("alb", stics_version = "V9.0")
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.