as_flextable.summary.tsgarch.estimate {tsgarch} | R Documentation |
Transform a summary object into flextable
Description
Transforms a “summary.tsgarch” object into a flextable with options on symbolic representation and model equation.
Usage
## S3 method for class 'summary.tsgarch.estimate'
as_flextable(
x,
digits = max(3L, getOption("digits") - 3L),
signif.stars = getOption("show.signif.stars"),
include.symbols = TRUE,
include.equation = TRUE,
include.statistics = TRUE,
table.caption = paste0(toupper(x$model), " Model Summary"),
...
)
Arguments
x |
an object of class “summary.tsgarch”. |
digits |
integer, used for number formatting. Optionally, to avoid scientific notation, set ‘options(scipen=999)’. |
signif.stars |
logical. If TRUE, ‘significance stars’ are printed for each coefficient. |
include.symbols |
logical. If TRUE, replaces parameter names with their symbols (if they exist). |
include.equation |
logical. If TRUE, adds a section with the symbolic model equation. |
include.statistics |
logical. If TRUE, adds a section with summary statistics on the model. |
table.caption |
an optional string for the table caption. |
... |
additional arguments passed to flextable method. |
Value
A flextable object.
[Package tsgarch version 1.0.2 Index]