sim_metrics: get possible metrics for comparing GLM outputs to field

In USGS-R/glmtools: Tools for working with the General Lake Model (GLM)

get possible metrics for comparing GLM outputs to field

Description

returns a character array of metric names that can be supported by compare_to_field. This function is only designed to handle calls to physical metrics that return a single value. An example of this behavior is thermocline depth (but not water density for all depth-resolved measurements).

Usage

sim_metrics(with_nml = FALSE)

Arguments

with_nml

include metrics that require information in the nml file

Value

a character array of metrics that can be used

Author(s)

Jordan S. Read

See Also

compare_to_field, resample_to_field, read_nml

Examples

sim_metrics()
sim_metrics(with_nml = TRUE)

USGS-R/glmtools documentation built on March 26, 2024, 5:43 p.m.