summary.bgvarest: Summarising Country-Specific VARX Submodels of a GVAR Model

View source: R/summary.bgvarest.R

summary.bgvarestR Documentation

Summarising Country-Specific VARX Submodels of a GVAR Model

Description

summary method for class "bgvarest".

Usage

## S3 method for class 'bgvarest'
summary(object, ci = 0.95, period = NULL, ctry = NULL, ...)

## S3 method for class 'summary.bgvarest'
print(x, digits = max(3L, getOption("digits") - 3L), ...)

Arguments

object

an object of class "bgvarest", usually, a result of a call to draw_posterior.

ci

a numeric between 0 and 1 specifying the probability of the credible band. Defaults to 0.95.

period

integer. Index of the period, for which the summary statistics should be generated. Only used for TVP or SV models. Default is NULL, so that the posterior draws of the last time period are used.

ctry

character. Name of the element in argument object, for which summary statistics should be obtained. If NULL (default), all country submodels are used.

...

further arguments passed to or from other methods.

x

an object of class "summary.bgvarest", usually, a result of a call to summary.bgvarest.

digits

the number of significant digits to use when printing.

Value

summary.bgvarest returns a list of class "summary.bgvarest", which contains summary statistics of country-specific submodels of class summary.ctryvarest.


franzmohr/bgvars documentation built on Sept. 2, 2023, 12:45 p.m.