R: Class for the result of the MCMC procedure.

pompp_fit-class {pompp}

R Documentation

Class for the result of the MCMC procedure.

Description

Objects of this class are the main objects of this package. They contain much information about the fitted model.

Usage

## S4 method for signature 'pompp_fit'
show(object)

## S4 method for signature 'pompp_fit'
print(x, ...)

## S3 method for class 'pompp_fit'
print(x, ...)

## S4 method for signature 'pompp_fit'
summary(object, ...)

## S3 method for class 'pompp_fit'
summary(object, ...)

## S4 method for signature 'pompp_fit'
names(x)

## S3 method for class 'pompp_fit'
names(x)

## S4 method for signature 'pompp_fit,ANY,ANY'
x[[i]]

## S4 method for signature 'pompp_fit'
x$name

## S4 method for signature 'pompp_fit'
as.array(x, ...)

## S3 method for class 'pompp_fit'
as.array(x, ...)

## S4 method for signature 'pompp_fit'
as.matrix(x, ...)

## S3 method for class 'pompp_fit'
as.matrix(x, ...)

## S4 method for signature 'pompp_fit'
as.data.frame(x, row.names = NULL, optional = FALSE, ...)

## S3 method for class 'pompp_fit'
as.data.frame(x, row.names = NULL, optional = FALSE, ...)

## S4 method for signature 'pompp_fit,pompp_fit'
e1 + e2

## S4 method for signature 'pompp_fit'
c(x, ...)

Arguments

`object`	A pompp_fit object.
`x`	A pompp_fit object.
`...`	Ignored in this version.
`i`	The requested slot.
`name`	The requested slot.
`row.names`	NULL or a character vector giving the row names for the data frame. Missing values are not allowed.
`optional`	logical. If TRUE, setting row names and converting column names to syntactic names is optional. See help('as.data.frame') for more. Leaving as `FALSE` is recommended.
`e1`	A pompp_fit object.
`e2`	A pompp_fit object with the same slots (except for initial values) as `e1`.

Value

show and print: The invisible object.

summary: A matrix with the summary statistics of the fit. It is also printed in the print method. The summary can be treated as a matrix, such as retrieving rows/columns and creating tables with the xtable package.

names: A character vector with the available options for the `$` and `[[` methods.

`$` and `[[`: The requested slot. Available options are not necessarily the class slots, and can be checked with the names method.

as.array: An array with dimensions I x C x P, where I stands for number of iterations, C for number of chains and P for total number of parameters. P is actually larger than the number of parameters in the model, as the the generated sizes of the latent processes and the log-posterior are also included. This is organized so that is ready for the bayesplot package functions.

as.matrix: The dimension of the output is I * C x (P + 2), where I stands for number of iterations, C for number of chains and P for total number of parameters. P is actually larger than the number of parameters in the model, as the generated sizes of the latent processes and the log-posterior are also included.

Two extra columns are included to indicate to which chain and to which iteration that draw belongs.

as.data.frame: The dimension of the output is I*C x P + 2, where I stands for number of iterations, C for number of chains and P for total number of parameters. P is actually larger than the number of parameters in the model, as the generated sizes of the latent processes and the log-posterior are also included.

Two extra columns are included to indicate to which chain and to which iteration that draw belongs. This is to facilitate the use of plotting results via the ggplot2 package if desired.

If row.names is left at NULL then row names are created as CcIi where c is the chain and i is the iteration of that row.

+: A new pompp_fit object where the chains are combined into a new multi-chain object. This can be used if chains are run in separate occasions or computers to combine them into a single object for analysis.

c: A new pompp_fit object where the chains are combined into a new multi-chain object. The + method is used for that, with the same arguments restrictions and results.

Fields