opp_render_diagnostic: Render diagnostic report for a given species

View source: R/OPPReporting.R

opp_render_diagnosticR Documentation

Render diagnostic report for a given species

Description

This function will generate a diagnostic report using the 'opp-diagnostic-report' RMarkdown template in OPPtools, with options to save the generated report as an .Rmd file in addition to the output PDF.

Usage

opp_render_diagnostic(
  params,
  save_rmd = FALSE,
  output_dir = "temp",
  out_format = "pdf_document",
  ...
)

Arguments

params

List of 19 parameter values used to generate report.

save_rmd

Logical (T/F). Should the .Rmd file used to generate the PDF report be saved as well?

output_dir

Output directory for generated files. Defaults to 'temp'. If the directory does not exist, the script will create the directory.

Examples

 ## Not run: 
for (i in 1:nrow(cpf_report_params)) {
   opp_render_diagnostic(cpf_report_params[i,],
                      out_format = 'pdf_document',
                      save_rmd = F,
                      output_dir = paste0('temp/OPP_report/',cpf_report_params$file_name[i]))

}

## End(Not run)

popovs/OPPtools documentation built on July 8, 2023, 2:29 a.m.