R: Create and work with parameter objects

param {mrgsolve} | R Documentation

## Create and work with parameter objects

### Description

See `numericlist` for methods to deal with `parameter_list` objects.

### Usage

    param(.x, ...)

    ## S4 method for signature 'mrgmod'
    param(.x, .y = NULL, ..., .pat = "*", .strict = FALSE)

    ## S4 method for signature 'mrgsims'
    param(.x, ...)

    ## S4 method for signature 'missing'
    param(..., .strict = TRUE)

    ## S4 method for signature 'list'
    param(.x, ...)

    ## S4 method for signature 'ANY'
    param(.x, ...)

    allparam(.x)

### Arguments

`.x` | the model object
`...` | passed along or name/value pairs to update the parameters in a model object
`.y` | list to be merged into parameter list
`.pat` | a regular expression (character) to be applied as a filter for which parameters to show when printing
`.strict` | if `TRUE`, all names to be updated must be found in the parameter list

### Details

Can be used to either get a parameter list object from a `mrgmod` model object or to update the parameters in a model object. For both uses, the return value is a `parameter_list` object. For the former use, `param` is usually called to print the parameters to the screen, but the `parameter_list` object can also be coerced to a list or numeric R object.

Use `allparam` to get a `parameter_list` object including both model parameters and data items listed in `$FIXED`.

### Value

An object of class `parameter_list` (see `numericlist`).

### Examples

    ## example("param")

    mod <- mrgsolve::house()

    param(mod)

    param(mod, .pat="^(C|F)") ## may be useful when large number of parameters

    class(param(mod))

    param(mod)$KA

    param(mod)[["KA"]]

    as.list(param(mod))

    as.data.frame(param(mod))

    param(mod, CL = 1.2)

    new_values <- list(CL = 1.3, VC = 20.5)

    param(mod, new_values)

[Package mrgsolve version 1.0.4 Index]