Render a QC Summary Document — renderQCSummary • review

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

renderQCSummary(.dirs_exclude = NULL, .output_dir = NULL)

Arguments

.dirs_exclude: Character string (optional). Vector of directories to exclude in the summary (relative to log root).
.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

The QC status of all scripts checked into SVN by each author will be displayed, along with a high level summary of all scripts that need to be QCed.

Examples

if (FALSE) {
  with_demoRepo({
    renderQCSummary()
  })
}