R: Methods for handling output with dplyr verbs

mrgsims_dplyr {mrgsolve} | R Documentation

## Methods for handling output with dplyr verbs

### Description

These methods modify the data in a mrgsims object and return a data frame. Contrast with the functions in mrgsims_modify.

### Usage

    ## S3 method for class 'mrgsims'
    pull(.data, ...)

    ## S3 method for class 'mrgsims'
    filter(.data, ...)

    ## S3 method for class 'mrgsims'
    group_by(.data, ..., add = FALSE, .add = FALSE)

    ## S3 method for class 'mrgsims'
    distinct(.data, ..., .keep_all = FALSE)

    ## S3 method for class 'mrgsims'
    mutate(.data, ...)

    ## S3 method for class 'each'
    summarise(.data, funs, ...)

    ## S3 method for class 'mrgsims'
    summarise(.data, ...)

    ## S3 method for class 'mrgsims'
    do(.data, ..., .dots)

    ## S3 method for class 'mrgsims'
    select(.data, ...)

    ## S3 method for class 'mrgsims'
    slice(.data, ...)

    as_data_frame.mrgsims(.data_, ...)

    ## S3 method for class 'mrgsims'
    as_tibble(.data_, ...)

    as.tbl.mrgsims(x, ...)

### Arguments

`.data` | an mrgsims object; passed to various `dplyr` functions
`...` | passed to other methods
`add` | passed to dplyr::group_by (for dplyr < `1.0.0`)
`.add` | passed to dplyr::group_by (for dplyr >= `1.0.0`)
`.keep_all` | passed to dplyr::distinct
`funs` | passed to dplyr::summarise_each
`.dots` | passed to various `dplyr` functions
`.data_` | mrgsims object
`x` | passed to dplyr::as.tbl

### Details

For the `select_sims` function, the dots `...` must be either compartment names or variables in `$CAPTURE`. An error will be generated if no valid names are selected or the names for selection are not found in the simulated output.

### See Also

mrgsims_modify

### Examples

    out <- mrgsim(house(), events = ev(amt = 100), end = 5, delta=1)

    dplyr::filter(out, time==2)

    dplyr::mutate(out, label = "abc")

    dplyr::select(out, time, RESP, CP)

[Package mrgsolve version 0.11.1 Index]