Render canonical manuscripts with Pandoc

Builds and optionally executes deterministic Pandoc commands for canonical manuscript source directories while preserving tool identity, logs, exit status, and output checksums.

Usage

pandoc_status(executable = Sys.which("pandoc"))

pandoc_render_arguments(manuscript_directory, format = c("html", "docx"), output = NULL)

render_manuscript(manuscript_directory, format = c("html", "docx"),
  pandoc = Sys.which("pandoc"), dry_run = FALSE, overwrite = FALSE)

validate_manuscript_render(x)

Arguments

executable, pandoc

Path to the Pandoc executable.

manuscript_directory

A validated manuscript source directory.

format

Output format, either html or docx.

output

Optional explicit output path.

dry_run

Return an execution record without invoking Pandoc.

overwrite

Permit replacement of an existing rendered output.

x

A PopgenVCFManuscriptRender record.

Value

pandoc_status() returns tool identity metadata; pandoc_render_arguments() returns a character argument vector; render_manuscript() returns a PopgenVCFManuscriptRender; validate_manuscript_render() returns TRUE invisibly.