export: Export scan objects to html or latex

Description

This function is in an experimental status. Export creates html files of tables or displayes them directly in the viewer pane of rstudio. When applied in rmarkdown, tables can also be created for pdf/latex output.

Usage

export(object, ...)
# S3 method for scdf
export(
  object,
  caption = NA,
  footnote = NA,
  filename = NA,
  kable_styling_options = list(),
  kable_options = list(),
  cols,
  ...
)
# S3 method for sc_desc
export(
  object,
  caption = NA,
  footnote = NA,
  filename = NA,
  kable_styling_options = list(),
  kable_options = list(),
  flip = FALSE,
  ...
)
# S3 method for sc_hplm
export(
  object,
  caption = NA,
  footnote = NA,
  filename = NA,
  kable_styling_options = list(),
  kable_options = list(),
  round = 2,
  nice = TRUE,
  ...
)
# S3 method for sc_plm
export(
  object,
  caption = NA,
  footnote = NA,
  filename = NA,
  kable_styling_options = list(),
  kable_options = list(),
  round = 2,
  nice = TRUE,
  ...
)
# S3 method for sc_overlap
export(
  object,
  caption = NA,
  footnote = NA,
  filename = NA,
  kable_styling_options = list(),
  kable_options = list(),
  round = 2,
  flip = FALSE,
  ...
)
# S3 method for sc_trend
export(
  object,
  caption = NA,
  footnote = NA,
  filename = NA,
  kable_styling_options = list(),
  kable_options = list(),
  round = 2,
  flip = TRUE,
  ...
)
# S3 method for sc_tauu
export(
  object,
  caption = NA,
  footnote = NA,
  filename = NA,
  kable_styling_options = list(),
  kable_options = list(),
  ...
)

Arguments

object

An scdf or an object exported from a scan function.

...

Further Arguments passed to internal functions.

caption

Character string with table caption. If left NA (default) a caption will be created based on the exported object.

footnote

Character string with table footnote. If left NA (default) a footnote will be created based on the exported object.

filename

Character string with the filename. If a filename is provided the output will be written into this file.

kable_styling_options

list with arguments passed to the kable_styling function.

kable_options

list with arguments passed to the kable function.

cols

Defines which columns are included when a scdf is exported. It is either a vector with variable names or the string "main" will select the central variables.

flip

If TRUE, some objects are exported with rows and columns flipped.

round

value for the digits argument passed to the internally used round function.

nice

If set TRUE (default) output values are rounded and optimized for publication tables.

Value

Returns a specif formated html (or latex).