Skip to contents

Deterministic manuscript revision records and diff reports

manuscript_revision_diffs.Rd

Creates immutable manuscript revision records, compares canonical manuscript sections, and writes deterministic revision-diff bundles. Explanations and reviewer links are recorded only when explicitly supplied by authors.

Usage

new_manuscript_revision(
  manuscript_id,
  revision_id,
  sections,
  parent_revision_id = "",
  summary = "",
  created_by = ""
)

validate_manuscript_revision(x)

compare_manuscript_revisions(before, after, annotations = NULL, strict = FALSE)

render_manuscript_revision_diff(diff)

write_manuscript_revision_diff(
  before,
  after,
  directory,
  annotations = NULL,
  overwrite = FALSE
)

Arguments

manuscript_id

Stable manuscript identifier.

revision_id

Stable revision identifier.

sections

Data frame containing section_id, title, and content.

parent_revision_id

Optional parent revision identifier.

summary

Optional explicit author-supplied revision summary.

created_by

Optional explicit creator identifier.

x

A manuscript revision record.

before

Earlier manuscript revision record.

after

Later manuscript revision record.

annotations

Optional data frame containing explicit section explanations and reviewer-comment links.

strict

Whether changed sections without explicit explanations raise an error.

diff

A manuscript revision diff returned by compare_manuscript_revisions().

directory

Parent output directory.

overwrite

Whether an existing output bundle may be replaced.

Value

new_manuscript_revision() returns a validated PopgenVCFManuscriptRevision. compare_manuscript_revisions() returns a deterministic PopgenVCFManuscriptRevisionDiff table. Rendering returns Markdown lines, writing returns the normalized output path invisibly, and validation returns TRUE invisibly.

Details

Revision identities and section ordering are deterministic. The comparison classifies sections as added, removed, modified, or unchanged and records canonical content hashes and count deltas. The implementation does not infer why scientific text changed, evaluate scientific correctness, or generate replacement prose.

See also

new_manuscript_regeneration_plan()