checkGrattanReport: Check Grattan Report

In HughParsonage/grattanReporter: Parses Grattan Reports, Possibly Creating PDFs also

Description

Check Grattan reports written is LaTeX for typing errors, significant warnings, and inconsistent style.

Usage

checkGrattanReport(path = ".", compile = FALSE, pre_release = FALSE,
  release = FALSE, .proceed_after_rerun, .no_log = TRUE,
  .log_psv = FALSE, embed = TRUE, rstudio = FALSE,
  update_grattan.cls = pre_release, filename = NULL)

checkGrattanReports(path = ".", compile = FALSE, pre_release = FALSE,
  release = FALSE, .proceed_after_rerun, .no_log = TRUE,
  embed = TRUE, rstudio = FALSE, update_grattan.cls = TRUE)

Arguments

path	Path to search for the tex source file.
compile	Should pdflatex be run on the report so the logs may be checked?
pre_release	Should the document be assumed to be final? Runs additional checks.
release	Should a final pdf be prepared for publication?
.proceed_after_rerun	On the occasions where infinitely many passes of pdflatex are required, include this to skip the error. Note that this will result in false cross-references or incompletely formatted bibliographies.
.no_log	Make no entry in the log file on the check's outcome. (Deprecated.)
.log_psv	If TRUE, return a table of the error details as pipe separated table.
embed	If FALSE, not attempt to embed the fonts using Ghostscript is attempted. Useful if Ghostscript cannot easily be installed. Set to TRUE for debugging or repetitive use (as in benchmarking).
rstudio	Use the RStudio API if available.
update_grattan.cls	Download grattan.cls from https://github.com/HughParsonage/grattex/blob/master/grattan.cls? Set to FALSE when checking the grattex repo itself. Also downloads the logos associated with the repository.
filename	If provided, the .tex file inside path to check. By default, NULL so the set to the sole .tex file within path.

Details

Options in the package

grattanReporter.quiet.progress = FALSE

Can be set to TRUE to avoid printing the output during the check.

Value

Called for its side-effect.

HughParsonage/grattanReporter documentation built on May 7, 2019, 5:02 a.m.