fx_output: Effex Function: Render Output

In sflippl/tectr: User Interface for Complex Datasets

Description

This function transforms the tibble which fx_info() yields (and which may be modified afterwards) into a certain form.

Usage

fx_output(info, form = "", out_format = "rst", ...)

fxe_output(info, form, out_format, ...)

## S3 method for class 'fxd_output_'
fxe_output(info, form, out_format, ...)

## S3 method for class 'fxd_output_asis'
fxe_output(info, form, out_format, ...)

## S3 method for class 'fxd_output_table'
fxe_output(info, form, out_format, out_file,
  digits = 2, ...)

## S3 method for class 'fxd_output_collapse'
fxe_output(info, form, out_format, out_file,
  cell_scheme = if (out_format == "latex") "<<name>>: <<value>>" else
  "{name}: {value}", digits = 2, cell_sep = ", ", .open = if
  (out_format == "latex") "<<" else "{", .close = if (out_format ==
  "latex") ">>" else "}", ...)

Arguments

info	The info tibble
form	What form should it take. fx_output can be extended via this argument (see fxe_output())
out_format	What format should the output be in? Default argument is "rst" which means an R object. For now, the other valid values are "markdown", "html" and "latex".
...	arguments for the fxe_output() methods
out_file	Should the object be saved somewhere? If yes, provide the path - the object will still be returned in the end.
cell_scheme	a character that specifies how every cell, in connection with its column name is styled. name enclosed by the characters specified in .open and .close (see the documentation of glue::glue()) refers to the column name and value to the cell content. Note that you will have to specify cell_scheme if you change .open or .close.
cell_spec

Forms

• form = "": This standard does nothing except removing the name column which should generally only be used for internal purposes. It is only compatible with out_format = NULL.

• form = "asis": This form changes absolutely nothing. It only works with out_format = NULL, as well.

• form = "table": This form generates a table and works with all output formats. It is mainly powered by knitr::kable() and you can pass additional options to both kable and kableExtra::kable_styling() via ...

• form = "collapse": This form generates one line for every row of the tibble. ... are passed on to format().

sflippl/tectr documentation built on May 6, 2019, 8:51 a.m.