summary.ESS: 'summary' method for class 'ESS'

Description Usage Arguments Details Value Author(s) Examples

View source: R/summary.ESS.R

Description

Summary method for ESS objects.

Usage

1
2
  ## S3 method for class 'ESS'
 summary(object, ...)

Arguments

object

an object of class ESS.

...

integer indicating the number of best models to be summarized.

Details

summary method for the ESS class. It returns a summary of the x object including the list of the best models visited

Value

The function summary returns a data frame containing the following fields describing all of the best models according to:

Rank

the rank of the model according to its posterior probability.

nVisits

the number of times the model has been visited during the run (including the burn-in).

FirstVisit

the iteration at which the model was first visited.

nEvalBefore1st

the number of iteration before the first visit of the model.

ModeSize

the number of variables in the model.

logCondPost

the log posterior probability (integrated over the shrinkage factor g).

postProb

the posterior probability of the model.

jeffrey

the Jeffrey's scale for the model.

modelName

the list of variables (predictors) included in the model.

Author(s)

Benoit Liquet, b.liquet@uq.edu.au,
Marc Chadeau-Hyam m.chadeau@imperial.ac.uk,
Leonardo Bottolo l.bottolo@imperial.ac.uk,
Gianluca Campanella g.campanella11@imperial.ac.uk

Examples

1
2
3
# load an ESS object
modelY_Hopx <- example.as.ESS.object()
summary(modelY_Hopx,20)

R2GUESS documentation built on May 2, 2019, 1:47 p.m.