Skip to contents

[Experimental] three buttons for adding cards, downloading and resetting the Report. The add module has add_report_card_simple id, the download module the download_button_simple id and the reset module the reset_button_simple id.

For more details see the vignette: vignette("simpleReporter", "teal.reporter").

Usage

simple_reporter_srv(
  id,
  reporter,
  card_fun,
  global_knitr = getOption("teal.reporter.global_knitr"),
  rmd_output = c(html = "html_document", pdf = "pdf_document", powerpoint =
    "powerpoint_presentation", word = "word_document"),
  rmd_yaml_args = list(author = "NEST", title = "Report", date =
    as.character(Sys.Date()), output = "html_document", toc = FALSE)
)

Arguments

id

character(1) this shiny module's id.

reporter

Reporter instance.

card_fun

function which returns a ReportCard instance, the function has a card argument and an optional comment argument.

global_knitr

list a global knitr parameters for customizing the rendering process.

rmd_output

character vector with rmarkdown output types, by default all possible c("pdf_document", "html_document", "powerpoint_presentation", "word_document"). If vector is named then those names will appear in the UI.

rmd_yaml_args

named list with Rmd yaml header fields and their default values. This list will result in the custom subset of User Interface inputs for the download reporter functionality. Default list(author = "NEST", title = "Report", date = Sys.Date(), output = "html_document", toc = FALSE). The list must include at least "output" field. The default value for "output" has to be in the rmd_output argument.

Details

To access the default values for the global_knitr parameter, use getOption('teal.reporter.global_knitr'). These defaults include:

  • echo = TRUE

  • tidy.opts = list(width.cutoff = 60)

  • tidy = TRUE if formatR package is installed, FALSE otherwise