Learn R Programming

BSL (version 3.0.0)

bsl-class: S4 class ``bsl''.

Description

The result from function bsl is saved as class ``BSL''.

Summarise a ``bsl'' class object.

Plot the univariate marginal posterior plot of a ``bsl'' class object.

Usage

# S4 method for bsl
show(object)

summary(object, ...)

# S4 method for bsl summary(object, thetaNames = NULL)

plot(x, y, ...)

# S4 method for bsl,missing plot(x, which = 1L, thin = 1, thetaTrue = NULL, options.plot = NULL, top = "Approximate Univariate Posteriors", options.density = list(), options.theme = list())

Arguments

object

A ``bsl'' class object to be displayed.

...

Other arguments.

thetaNames

Parameter names to be shown in the summary table. If not given, parameter names of the ``bsl'' object will be used by default.

x

A ``bsl'' class object to plot.

y

Ignore.

which

An integer argument indicating which plot function to be used. The default, 1L, uses the plain plot to visualise the result. 2L uses ggplot2 to draw the plot.

thin

A numeric argument indicating the gap between samples to be taken when thinning the MCMC draws. The default is 1, which means no thinning is used.

thetaTrue

A set of values to be included on the plots as a reference line. The default is NULL.

options.plot

A list of additional arguments to pass into the plot function. Only use when which is 1L.

top

A character argument of the combined plot title if which is 2L.

options.density

A list of additional arguments to pass into the geom_density function. Only use when which is 2L.

options.theme

A list of additional arguments to pass into the theme function. Only use when which is 2L.

Value

A vector of the number of simulations per iteration, acceptance rate of the Markov chain annd scaled effective sample size for each parameter.

Methods (by generic)

  • show: Display the basic information of a ``bsl'' object. See show.bsl.

  • summary: Summarise a bsl class object. See summary.bsl.

  • plot: Plot the univariate marginal posterior plot of a ``bsl'' class object. See plot.bsl.

Slots

theta

Object of class ``matrix''. MCMC samples from the joint approximate posterior distribution of the parameters.

loglike

Object of class ``numeric''. Accepted MCMC samples of the estimated log-likelihood values.

call

Object of class ``call''. The original code that was used to call the method.

model

Object of class ``BSLMODEL''.

acceptanceRate

Object of class ``numeric''. The acceptance rate of the MCMC algorithm.

earlyRejectionRate

Object of class ``numeric''. The early rejection rate of the algorithm (early rejection may occur when using bounded prior distributions).

errorRate

Object of class ``numeric''. The error rate. If any infinite summary statistic or positive infinite loglike occurs during the process, it is marked as an error and the proposed parameter will be rejected.

y

Object of class ``ANY''. The observed data.

n

Object of class ``numeric''. The number of simulations from the model per MCMC iteration.

M

Object of class ``numeric''. The number of MCMC iterations.

covRandWalk

Object of class ``matrix''. The covariance matrix used in multivariate normal random walk proposals.

method

Object of class ``character''. The character argument indicating the used method.

shrinkage

Object of class ``characterOrNULL''. The character argument indicating the shrinkage method.

penalty

Object of class ``numericOrNULL''. The penalty value.

GRC

Object of class ``logical''. Whether the Gaussian rank correlation matrix is used.

logitTransform

Object of class ``logical''. The logical argument indicating whether a logit transformation is used in the algorithm.

logitTransformBound

Object of class ``matrixOrNULL''. The matrix of logitTransformBound.

standardise

Object of class ``logical''. The logical argument that determines whether to standardise the summary statistics.

parallel

Object of class ``logical''. The logical value indicating whether parallel computing is used in the process.

parallelArgs

Object of class ``listOrNULL''. The list of additional arguments to pass into the foreach function.

time

Object of class ``difftime''. The running time.