API

PosteriorDB

Functionality for working with instances of a posterior database.

See https://github.com/stan-dev/posteriordb for more information.

AbstractImplementation

Abstract type for implementations of a model.

Subtypes should implement the methods load and path.

Dataset

Pointer to a dataset in a PosteriorDatabase.

See also: dataset, dataset_names

Model

Pointer to a model in a PosteriorDatabase.

See also: model, model_names

Posterior

Pointer to a posterior in a PosteriorDatabase.

See also: posterior, posterior_names

PosteriorDatabase

A posterior database object using the files at path.

See also: database, posterior_names, model_names, dataset_names

ReferencePosterior

Pointer to a reference posterior in a PosteriorDatabase.

See also: Posterior, reference_posterior, posterior

StanModelImplementation

Implementation of a model using Stan.

See also: implementation, load

database([path::String]) -> PosteriorDatabase

Return a pointer to the PosteriorDatabase stored at path.

If path is not given, the default posterior database downloaded from a GitHub release is used.

database(obj) -> PosteriorDatabase

Return the database containing obj.

obj can be a Posterior, Model, AbstractImplementation, Dataset, or ReferencePosterior.

dataset(db::PosteriorDatabase, name::String) -> Dataset

Return a dataset object for the dataset with name name in the database db.

dataset(posterior::Posterior) -> Dataset

Return the dataset entry of posterior.

dataset_names(db::PosteriorDatabase) -> Vector{String}

Return the names of all datasets in the database.

implementation(model::Model, framework::String) -> AbstractImplementation

Return the implementation of the model for the given framework.

implementation_names(model::Model) -> Vector{String}

Return the names of frameworks with code for the model.

info(obj) -> AbstractDict

Return the info dictionary for obj.

obj can be a Posterior, Model, Dataset, or ReferencePosterior.

load(implementation::AbstractImplementation) -> String

Load the model implementation and return the code as a string.

load(dataset::Dataset) -> OrderedDict{String,Any}

Load and return the data for dataset.

load(dataset::Dataset, String) -> String

Return the data for dataset as an unparsed JSON string.

load(rp::ReferencePosterior) -> Vector{OrderedDict{String,Any}}

Load and return the reference draws for the reference posterior rp.

load(rp::ReferencePosterior, String) -> String

Return the reference draws as an unparsed JSON string.

model(db::PosteriorDatabase, name::String) -> Model

Return a model object for the model with name name in the database db.

model(posterior::Posterior) -> Model

Return the model entry of posterior.

model_names(db::PosteriorDatabase) -> Vector{String}

Return the names of all models in the database.

name(obj) -> String

Return the name of obj.

obj can be a Posterior, Model, Dataset, or ReferencePosterior.

path(implementation::AbstractImplementation) -> String

Absolute path to the file containing the model implementation.

path(dataset::Dataset) -> String

Absolute path to the file containing the model dataset.

path(db::PosteriorDatabase) -> String

Absolute path to the database db.

path(rp::ReferencePosterior) -> String

Return the path to the file storing the reference draws for the reference posterior rp.

posterior(db::PosteriorDatabase, name::String) -> Posterior

Return a posterior object for the posterior with name name in the database db.

posterior_names(db::PosteriorDatabase) -> Vector{String}

Return the names of all posteriors in the database.

recursive_stack(x::AbstractArray)

If x is an array of arrays, recursively stack into a single array whose dimensions are ordered with dimensions of the innermost container first and outermost last.

reference_posterior(db::PosteriorDatabase, name::String) -> ReferencePosterior

Return a pointer to the reference posterior with name name in the database db.

reference_posterior(posterior::Posterior) -> Union{Nothing,ReferencePosterior}

Return the reference posterior entry of posterior.

If no reference posterior is available, nothing is returned.