ffm_param_info: Retrieves information for a parameter label.

In pzylstra/frame_r: Fire Research and Modelling Environment

Retrieves information for a parameter label.

Description

Searches for a row in the ParamInfo table with a matching parameter label. The comparison ignores case and white-space. If a non-NULL value is supplied for section the check is restricted to parameter labels in that section (site, stratum or species).

Usage

ffm_param_info(label, section = NULL, no.match.error = FALSE)

Arguments

label	The parameter label.
section	If not NULL, one of site, stratum or species.
no.match.error	If TRUE an error results when a unique match is not found for the input label; if FALSE (default) the function returns NULL when there is no unique match.

Value

Parameter info as a single row data frame; or NULL if no matching label was found and no.match.error is FALSE.

pzylstra/frame_r documentation built on Nov. 12, 2023, 1:55 a.m.