stansim_collection: Construct an S3 object of type stansim_collection

Description Usage Arguments Value

View source: R/stansim_collection.R

Description

A constructor function for creating S3 objects of class stansim_collection. stansim_collection objects are the preferred means of managing and storing the results of multiple stan simulations ran using stansim().

Usage

1
stansim_collection(collection_name, data, refitted, simulations)

Arguments

collection_name

A name attached to the stansim_collection object to help identify it. It is strongly recommended that an informative name is assigned.

data

The tidy dataframe containing data from all grouped simulations.

refitted

A dataframe containing a row for every refitted dataset, listing the simulation to which it belonged and the dataset name.

simulations

A list of all simulation data other than estimated values and the list of refitted data.

Value

An S3 object of class stansim_collection.


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