generate_plot_type_reports — generate_plot_type

Renders one report per plot type, collating the corresponding plot across all files, intervals, and channels using an Rmd template. Output is HTML by default; set pdf = TRUE for PDF output (requires additional system dependencies).

Usage

generate_plot_type_reports(
  params,
  file_rows,
  storage_fold = "plots",
  plot_report_dir = file.path(params$paths$base_dir, "reports", "plot_reports"),
  pdf = FALSE
)

Arguments

params: A named list of analysis parameters as produced by make_params().
file_rows: A tibble of file metadata as produced by index_files().
storage_fold: Character string naming the subfolder within each file's results directory where plots are stored. Defaults to "plots".
plot_report_dir: Character string giving the output directory for rendered reports. Defaults to file.path(params$paths$base_dir, "reports", "plot_reports").
pdf: Logical; if TRUE render PDF reports instead of HTML. Requires magick, tinytex, and a TinyTeX installation (tinytex::install_tinytex()). Defaults to FALSE.

Value

Called for its side effects (reports written to plot_report_dir). Returns NULL invisibly.

Examples

if (FALSE) { # \dontrun{
generate_plot_type_reports(params, file_rows)
generate_plot_type_reports(params, file_rows, pdf = TRUE)
} # }