R: Simulate from a model object with quicker turnaround

mrgsim_q {mrgsolve} | R Documentation

## Simulate from a model object with quicker turnaround

### Description

Use the function when you would usually use `mrgsim_d`, but you need a quicker turnaround time. The timing differences might be difficult to detect for a single simulation run but could become appreciable with repeated simulation. See `details` for important differences in how `mrgsim_q` is invoked compared to `mrgsim` and `mrgsim_d`. This function should always be used for benchmarking simulation time with mrgsolve.

### Usage

    mrgsim_q(
      x,
      data,
      recsort = 1,
      stime = numeric(0),
      output = "mrgsims",
      skip_init_calc = FALSE,
      simcall = 0
    )

### Arguments

`x` | a model object
`data` | a simulation data set
`recsort` | record sorting flag
`stime` | a numeric vector of observation times; these observation times will only be added to the output if there are no observation records in `data`
`output` | output data type; if `mrgsims`, then the default output object is returned; if `"df"` then a data frame is returned
`skip_init_calc` | don't use `$MAIN` to calculate initial conditions
`simcall` | not used; only the default value of 0 is allowed

### Details

This function does not support the piped simulation workflow. All arguments must be passed into the function except for `x`.

A data set is required for this simulation workflow. The data set can have only dosing records or doses with observations. When the data set only includes doses, a single numeric vector of observation times should be passed in.

This simulation workflow does not support `Req` (request) functionality. All compartments and captured variables will always be returned in the simulation output.

This simulation workflow does not support carry-out functionality.

This simulation workflow does not accept arguments to be passed to `update`. This must be done by a separate call to `update`.

This simulation workflow does not support use of event objects. If an event object is needed, it should be converted to a data set prior to the simulation run (see `as_data_set` or `as.data.frame.ev`.

This simulation workflow does not support idata sets or any feature enabled by idata set use. Individual level parameters should be joined onto the data set prior to simulation. Otherwise `mrgsim_i` or `mrgsim_ei` should be used.

By default, a mrgsims object is returned (as with `mrgsim`). Use the `output="df"` argument to request a plain data.frame of simulated data on return.

### See Also

`mrgsim`, `mrgsim_variants`, `qsim`

### Examples

    mod <- mrgsolve::house()

    data <- expand.ev(amt = c(100,300,1000))

    out <- mrgsim_q(mod,data)

    out

[Package mrgsolve version 0.11.1 Index]