prior_summary.varstan: Generic function for extracting information about prior...

View source: R/report.R

prior_summary.varstanR Documentation

Generic function for extracting information about prior distributions

Description

The function returns a report with the users defined model for the given time series data and all the current defined priors of the model.

Usage

## S3 method for class 'varstan'
prior_summary(object, ...)

Arguments

object

a varstan object or one of the defined current defined reports.

...

additional values need in print methods.

Details

if object is a varstan object the function will print the information of the defined model inside of the object. If object is one of the model classes (like Sarima or garch) then it will print the report information as well.

Value

none. prints a string with the defined time series model report

Author(s)

Asael Alonzo Matamoros

Examples

dat2 = garch(birth,order = c(1,1,0))
prior_summary(dat2)


bayesforecast documentation built on June 8, 2025, 10:42 a.m.