get_model_data: Mapping of Simulation Model Functions

View source: R/function_mapping.R

get_model_dataR Documentation

Mapping of Simulation Model Functions

Description

Provides information about the function for dynamic predictions associated to a valid simulation_model key. If simulation_model is missing or NULL, a character vector of valid model keys is provided. This function is designed as an assistant for using the functions predict_inactivation and fit_dynamic_inactivation. For the adjustment of isothermal experiments with the function fit_isothermal_inactivation, use the function get_isothermal_model_data.

Usage

get_model_data(simulation_model = NULL)

Arguments

simulation_model

(optional) character with a valid model key or NULL.

Value

If simulation_model is NULL or missing, a character vector of possible names. Otherwise, a list including information of the relevant function:

  • ode: Pointer to the function defining the model ode.

  • cost: Pointer to the function calculating the error of the approximation.

  • dtemp: logical defining whether the function requires the definition of the first derivative of temperature.

  • variables: a character vector defining which entry variables are needed by the model.

  • variables_priv: for internal use only.

  • parameters: character vector with the parameters needed by the model.

See Also

predict_inactivation, fit_dynamic_inactivation


albgarre/bioinactivation documentation built on Nov. 27, 2022, 9:19 a.m.