Render a QC Summary Document — renderQCSummary • qctools

This function generates a QC summary based on scripts within a given project and renders it into a PDF report.

renderQCSummary(.output_dir = NULL)

Arguments

.output_dir: Character string (optional). Path to the directory where the output PDF should be saved. If not provided, the document will not be saved locally.

Value

Invisible. The function will save a PDF report named "qc-summary-(current date).pdf" to the specified output directory (if available). If the R session is interactive, it will also open the PDF in the default browser.

Details

A high level summary of all scripts that need to be QCed will be displayed along with a summary of recently modified scripts that have not been assigned to the QC log.

Examples

if (FALSE) { # \dontrun{
  with_demoRepo({
    renderQCSummary()
  })
} # }