get_nml_value: gets a nml value according to an arg_name

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

gets a nml value according to an arg_name

Description

This function returns an nml value according to the arg_name nml list for GLM.

Usage

get_nml_value(glm_nml = NA, arg_name, nml_file = "template", ...)

Arguments

glm_nml	a nml (a list) for GLM config
arg_name	a string representing a valid field in glm_nml
nml_file	a string with the path to the GLM glm2.nml file or 'template' for loading the GLM template nml file with GLM3r (default)
...	additional arguments passed to get_block, such as warn=TRUE

Value

arg_val value for the valid field in glm_nml specified by arg_name

Author(s)

Jordan S. Read

See Also

read_nml, set_nml

Examples

# read in default nml template from GLM3r
glm_nml <- read_nml()
get_nml_value(glm_nml,arg_name = 'Kw')

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