summary.hsstan: Summary for the fitted model

Description Usage Arguments Value Examples

View source: R/summaries.R

Description

Summary for the fitted model

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
## S3 method for class 'hsstan'
summary(
  object,
  pars = NULL,
  prob = 0.95,
  digits = 2,
  sort = NULL,
  decreasing = TRUE,
  max.rows = NULL,
  ...
)

Arguments

object

An object of class hsstan.

pars

Vector of parameter names to be extracted. If NULL (default) then this refers to the set of predictors used in the model.

prob

Width of the posterior intervals (0.95, by default).

digits

Number of decimal places to be reported (2 by default).

sort

Column name used to sort the results according to the absolute value of the column. If NULL (default) or the column name cannot be found, no sorting occurs.

decreasing

Whether the results should be sorted in decreasing order when a valid column name is specified in sort (TRUE by default).

max.rows

Maximum number of rows to be returned. If NULL (default) or 0, all results are returned.

...

Currently ignored.

Value

A matrix with summaries from the posterior distribution of the parameters of interest.

Examples

1
2
# continued from ?hsstan
summary(hs.biom)

hsstan documentation built on Sept. 16, 2021, 9:11 a.m.