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 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_power
export(
  object,
  caption = NA,
  footnote = NA,
  filename = NA,
  kable_styling_options = list(),
  kable_options = list(),
  ...
)
# 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_smd
export(
  object,
  caption = NA,
  footnote = NA,
  filename = NA,
  select = c("Case", `Mean A` = "mA", `Mean B` = "mB", `SD A` = "sdA", `SD B` = "sdB",
    `SD Cohen` = "sd cohen", `SD Hedges` = "sd hedges", "Glass' delta", "Hedges' g",
    "Hedges' g correction", "Hedges' g durlak correction", "Cohen's d"),
  kable_styling_options = list(),
  kable_options = list(),
  round = 2,
  flip = FALSE,
  ...
)
# S3 method for sc_tauu
export(
  object,
  caption = NA,
  footnote = NA,
  filename = NA,
  select = "auto",
  kable_styling_options = list(),
  kable_options = list(),
  meta = TRUE,
  ...
)
# S3 method for sc_trend
export(
  object,
  caption = NA,
  footnote = NA,
  filename = NA,
  kable_styling_options = list(),
  kable_options = list(),
  round = 2,
  ...
)
# S3 method for scdf
export(
  object,
  caption = NA,
  footnote = NA,
  filename = NA,
  kable_styling_options = list(),
  kable_options = list(),
  cols,
  ...
)

Value

Returns or displays a specially formatted html (or latex) file.

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: String containing the file name. If a filename is given the output will be written to that file.
kable_styling_options: list with arguments passed to the kable_styling function.
kable_options: list with arguments passed to the kable function.
round: Integer passed to the digits argument internally used to round values.
nice: If set TRUE (default) output values are rounded and optimized for publication tables.
flip: If TRUE, some objects are exported with rows and columns flipped.
select: Character vector with name of variables to be included. When the vector is named, variables are renamed appropriately.
meta: If TRUE, the results of the meta analysis will be exported. If FALSE, each single-case is exported.
cols: Defines which columns are included when exporting an scdf. It is either a vector of variable names or the string "main" will select the central variables.