PSTR (version 2.0.0)

print.PSTR: Print a PSTR model object

Description

Print method for objects of class "PSTR".

Value

Invisibly returns x.

Arguments

x

An object of class "PSTR".

...

Further arguments passed to the underlying print routine. See Arguments below.

Arguments

The following arguments are supported (they are forwarded to the R6 method x$print()):

format

Character. Output format passed to knitr::kable() (for example "simple", "pipe", "latex"). Default is "simple".

mode

Character vector specifying which sections to print. It is matched (partially) against c("summary","tests","estimates","evaluation"). Default is "summary".

digits

Integer. Number of significant digits used in printed tables. Default is 4.

Details

The print output is organised into four sections:

"summary"

Data summary: panel dimensions, dependent variable, linear/non-linear regressors, transition variables.

"tests"

Specification tests: linearity (homogeneity) tests and the sequence of homogeneity tests (optionally with WB/WCB p-values if available).

"estimates"

Estimation results: coefficient estimates with standard errors and t-ratios, printed in chunks to fit the console width.

"evaluation"

Evaluation tests: parameter constancy and no-remaining-nonlinearity tests (optionally with WB/WCB p-values if available).

In addition to calling print(x, ...), the same functionality is available as an R6 method via x$print(...).

See Also

NewPSTR, LinTest, WCB_LinTest, EstPSTR, EvalTest, WCB_TVTest, WCB_HETest.

Examples

# \donttest{
pstr <- NewPSTR(Hansen99, dep = "inva", indep = 4:20,
               indep_k = c("vala","debta","cfa","sales"),
               tvars = c("vala","debta","cfa","sales"), iT = 14)

# default: summary only
pstr

# specification tests
print(pstr, mode = "tests", format = "simple")
print(pstr, mode = "tests", format = "pipe", caption = "The test results")

# estimates
print(pstr, mode = "estimates")

# evaluation
print(pstr, mode = "evaluation")

# R6 method interface (same output)
pstr$print(mode = c("summary","tests"))
# }