as_flextable function

Transform a summary object into flextable

Transform a summary object into flextable

Transforms a tstest.test object into a flextable with options on symbolic representation and model equation.

## S3 method for class 'tstest.berkowitz' as_flextable( x, digits = max(3L, getOption("digits") - 3L), signif.stars = getOption("show.signif.stars"), include.decision = FALSE, table.caption = x$test_name, footnote.reference = FALSE, ... ) ## S3 method for class 'tstest.dac' as_flextable( x, digits = max(3L, getOption("digits") - 3L), signif.stars = getOption("show.signif.stars"), include.decision = FALSE, table.caption = x$test_name, footnote.reference = FALSE, ... ) ## S3 method for class 'tstest.gmm' as_flextable( x, digits = max(3L, getOption("digits") - 3L), signif.stars = getOption("show.signif.stars"), include.decision = FALSE, collapse = TRUE, use.symbols = TRUE, table.caption = x$test_name, footnote.reference = FALSE, ... ) ## S3 method for class 'tstest.hongli' as_flextable( x, digits = max(3L, getOption("digits") - 3L), signif.stars = getOption("show.signif.stars"), include.decision = FALSE, table.caption = x$test_name, footnote.reference = FALSE, ... ) ## S3 method for class 'tstest.minzar' as_flextable( x, digits = max(3L, getOption("digits") - 3L), signif.stars = getOption("show.signif.stars"), include.decision = FALSE, table.caption = x$test_name, footnote.reference = FALSE, ... ) ## S3 method for class 'tstest.nyblom' as_flextable( x, digits = max(3L, getOption("digits") - 3L), signif.stars = getOption("show.signif.stars"), include.decision = FALSE, use.symbols = TRUE, table.caption = x$test_name, footnote.reference = FALSE, ... ) ## S3 method for class 'tstest.shortfall_de' as_flextable( x, digits = max(3L, getOption("digits") - 3L), signif.stars = getOption("show.signif.stars"), include.decision = FALSE, table.caption = x$test_name, footnote.reference = FALSE, ... ) ## S3 method for class 'tstest.signbias' as_flextable( x, digits = max(3L, getOption("digits") - 3L), signif.stars = getOption("show.signif.stars"), include.decision = FALSE, use.symbols = TRUE, table.caption = x$test_name, footnote.reference = FALSE, ... ) ## S3 method for class 'tstest.vares' as_flextable( x, digits = max(3L, getOption("digits") - 3L), signif.stars = getOption("show.signif.stars"), include.decision = FALSE, table.caption = x$test_name, footnote.reference = FALSE, ... ) ## S3 method for class 'tstest.var_cp' as_flextable( x, digits = max(3L, getOption("digits") - 3L), signif.stars = getOption("show.signif.stars"), include.decision = FALSE, table.caption = x$test_name, footnote.reference = FALSE, ... )

Arguments

  • x: an object of which inherits a tstest class.
  • digits: integer, used for number formatting. Optionally, to avoid scientific notation, set options(scipen=999) .
  • signif.stars: logical. If TRUE, significance stars are printed.
  • include.decision: prints out whether to reject the NULL at the 5% level of significance.
  • table.caption: an optional string for the table caption.
  • footnote.reference: whether to include the reference paper of the test in the footnotes.
  • ...: not currently used. The returned object can be manipulated further using flextable.
  • collapse: collapses the results for multiple lags to just report the joint test.
  • use.symbols: for tests which either have parameters for which the latex symbols were included in the calling function or for which the tests generate values which can be represented as latex symbols, then these will be generated.

Returns

A flextable object.

  • Maintainer: Alexios Galanos
  • License: GPL-2
  • Last published: 2024-10-24