get_param_names: Extract the daily parameter names from a metabolism model.

View source: R/metab_model_interface.R

get_param_namesR Documentation

Extract the daily parameter names from a metabolism model.

Description

A function in the metab_model_interface. Returns vectors of the required and optional daily metabolism parameters for the model.

Usage

get_param_names(metab_model, ...)

## S3 method for class 'character'
get_param_names(metab_model, ...)

## S3 method for class 'metab_model'
get_param_names(metab_model, ...)

Arguments

metab_model

A metabolism model object or model name for which to return the list of required and optional metabolism parameters.

...

Placeholder for future arguments

Value

Returns a list of two vectors, the names of the required and optional daily metabolism parameters, respectively.

Methods (by class)

  • character: This implementation is shared by many model types

  • metab_model: Lets you pass in a model object rather than a character string

See Also

Other metab_model_interface: get_data_daily(), get_data(), get_fitting_time(), get_fit(), get_info(), get_params(), get_specs(), get_version(), predict_DO(), predict_metab()

Examples


# pass in a character string:
get_param_names(mm_name('mle', GPP_fun='satlight'))
get_param_names(mm_name('bayes'))
get_param_names(mm_name('Kmodel'))
get_param_names(mm_name('night'))
get_param_names(mm_name('sim'))

# or pass in a metab_model object:
dat <- data_metab('1','30')
get_param_names(metab(specs(mm_name('mle', ER_fun='q10temp')), data=dat))
get_param_names(metab(specs('night'), data=dat))
get_param_names(metab(specs('sim'), data=dat))

USGS-R/streamMetabolizer documentation built on Aug. 15, 2023, 7:50 a.m.