Automatic manuscript generation — manuscript-generation • popgenVCF

Construct, validate, render, and write deterministic manuscript sources from canonical popgenVCF project and publication records. Generated factual content is kept separate from author-supplied scientific interpretation.

Usage

new_manuscript(
  project,
  publication = NULL,
  title = project$name,
  authors = NULL,
  abstract = NULL,
  keywords = character(),
  introduction = NULL,
  results = NULL,
  discussion = NULL,
  declarations = list()
)

validate_manuscript(x)

render_manuscript_markdown(manuscript)

write_manuscript(manuscript, directory, overwrite = FALSE)

Arguments

project: A validated PopgenVCFProject.
publication: A PopgenVCFPublicationBundle; generated from project when omitted.
title: Manuscript title.
authors: Author metadata containing at least a name column and optionally affiliation, email, ORCID, and corresponding-author status.
abstract: Author-supplied abstract.
keywords: Character vector of manuscript keywords.
introduction: Author-supplied introduction.
results: Author-supplied scientific interpretation for Results.
discussion: Author-supplied discussion.
declarations: Named overrides for generated declaration text.
x: A PopgenVCFManuscript or generated manuscript directory.
manuscript: A validated PopgenVCFManuscript.
directory: Output directory.
overwrite: Whether a non-empty output directory may be replaced.

Value

new_manuscript() returns a validated PopgenVCFManuscript. render_manuscript_markdown() returns deterministic Markdown source. write_manuscript() invisibly returns the normalized output directory. Validation returns TRUE invisibly.