extract_refitted.stansim_collection: Extract details of refitted datasets from a...

In Ewan-Keith/rstansim: Simulation Studies with Stan

Description

Applied to an object of type stansim_collection, extract_refitted() will return a dataframe of simulation-dataset pairings that have been refitted since the initial simulation.

Usage

## S3 method for class 'stansim_collection'
extract_refitted(object, sim_names = "all",
  datasets = "all", ...)

Arguments

object	An object of S3 class stansim_collection.
sim_names	Either a character vector containing the names of the stansim_simulation objects grouped in the collection, or the string "all". The former will only return values for the corresponding simulations, the latter applies no filtering on stansim simulations.
datasets	Either a character vector containing the names of datasets (as provided to the original stansim call) fitted, or the string "all". The former will only return values for the corresponding datasets, the latter applies no filtering on stansim datasets.
...	other arguments not used by this method.

Value

A dataframe with the simulation titles and dataset names of refitted datasets.

Examples

## Not run: 
# extract all refitted indicators
extract_refitted(collection)

# extract only datasets from "simulation1"
extract_refitted(collection, sim_names = "simulation1")

# extract only indicators for dataset "data-file_12.rds"
extract_refitted(collection, datasets = "data-file_12.rds")


## End(Not run)

Ewan-Keith/rstansim documentation built on May 6, 2019, 4:08 p.m.