get_output: Import samplesim results

Description Usage Arguments Value See Also Examples

View source: R/get_output.R

Description

This function imports samplesim simulation results. More specifically it loads the median and width of credible intervals.

Usage

1
get_output(name, path = ".", change = FALSE, reference = NULL)

Arguments

name

a character of length 1 giving the name of the simulation. If NULL (default) the simulation will be named by the time of the simulation. This name will serve to create a directory in which results will be stored.

path

a character string of length 1. The directory to save results. This directory must exist and can be an absolute or a relative path. Default is the current working directory.

change

a logical value. If TRUE values are expressed as a percentage of change compared to a reference. Default is FALSE.

reference

an integer. The reference state to compute percentage of change. If NULL (default) the minimum value of sample size will be used.

Value

A data frame with five columns:

If change = TRUE, then the column replicate is omitted and results are aggregated over replicates.

See Also

samplesim(), plot_samplesim(), plot_isospace()

Examples

1
2
3
4
5
## Not run: 
## Please visit the vignette available at: 
## https://ahasverus.github.io/samplesim/articles/samplesim.html

## End(Not run)

ahasverus/samplesim documentation built on July 8, 2021, 11:03 a.m.