Learn R Programming

⚠️There's a newer version (0.0.5) of this package.Take me there.

universals

universals provides S3 generic methods and some default implementations for Bayesian analyses that generate Markov Chain Monte Carlo (MCMC) samples.

The purpose of ‘universals’ is to reduce package dependencies and conflicts. The ‘nlist’ package implements all the methods for its ‘nlists’ class.

Philosophy

The methods are primarily designed to be used for Bayesian analyses that generate Markov Chain Monte Carlo (MCMC) samples but many can also be used for Maximum Likelihood (ML) and other types of analyses.

The names of the functions are based on the following definitions/concepts:

  • A term is a single real or integer value.
  • A par (short for parameter) is a scalar, vector, matrix or array of terms, ie a numeric atomic object.
  • An MCMC object is a collection of MCMC samples that refer to a set of terms.
  • The samples are arranged in one or more chains of the same length (number of iterations).
  • The number of simulations is the product of the number of iterations and the number of chains.
  • The number of samples is the product of the number of simulations and the number of

terms.

Installation

To install the developmental version from GitHub

# install.packages("remotes")
remotes::install_github("poissonconsulting/universals")

Usage

universals is designed to be used by package developers.

It is recommended to import and re-export the generics of interest. For example, to provide a method for the S3 pars() method, use the following roxygen2 code:

#' @importFrom universals pars
#' @export
universals::pars

Contribution

Please report any issues.

Pull requests are always welcome.

Code of Conduct

Please note that the universals project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.

Copy Link

Version

Install

install.packages('universals')

Monthly Downloads

1,334

Version

0.0.1

License

MIT + file LICENSE

Issues

Pull Requests

Stars

Forks

Maintainer

Joe Thorley

Last Published

May 31st, 2020

Functions in universals (0.0.1)

nsims

Number of Simulations
npars

Number of Parameters
niters

Number of Iterations
rhat_terms

R-hat Terms
rhat_pars

R-hat Parameters
npdims

Number of Parameter Dimensions
nsams

Number of Samples
ndims

Number of Dimensions
estimates

Estimates
nchains

Number of Chains
pdims

Parameter Dimensions
rhat

R-hat
params

Parameter Descriptions
set_pars

Set Parameters
pars

Parameter Names
nterms

Number of Terms
split_chains

Split Chains
universals-package

universals: S3 Generics for Bayesian Analyses
esr_terms

Effective Sampling Rate for Terms
esr_pars

Effective Sampling Rate for Parameters
esr

Effective Sampling Rate
bind_chains

Bind by Chains.
converged_terms

Converged Terms
collapse_chains

Collapse Chains
converged_pars

Converged Parameters
converged

Converged
dims

Dimensions