Build reports for listed datasets — dataset

Builds a detailed report for every dataset with a unique dataset_id, based on the template Rmd file provided. The reports are rendered as html files and saved in the specified output folder.

dataset_report(
  dataset_id,
  austraits,
  overwrite = FALSE,
  output_path = "export/reports",
  input_file = system.file("support", "report_dataset.Rmd", package = "traits.build"),
  quiet = TRUE,
  keep = FALSE
)

Arguments

dataset_id: Name of specific study/dataset
austraits: Compiled austraits database
overwrite: Logical value to determine whether to overwrite existing report
output_path: Location where rendered report will be saved
input_file: Report script (.Rmd) file to build study report
quiet: An option to suppress printing during rendering from knitr, pandoc command line and others
keep: Keep intermediate Rmd file used?

Value

Html file of the rendered report located in the specified output folder