Deterministic reporting checklists — reporting

Create, validate, evaluate, render, and write immutable reporting checklists. Checklist completion is based only on explicit author-supplied responses and evidence; missing facts are never inferred.

Usage

new_reporting_checklist(
  id,
  items,
  version = "1.0",
  title = id,
  organization = "popgenVCF",
  status = c("generic", "verified", "deprecated"),
  source_url = NA_character_,
  source_date = NA_character_,
  description = "Deterministic reporting checklist"
)

validate_reporting_checklist(x)

generic_reporting_checklist()

validate_reporting_checklist_responses(checklist, responses = NULL, strict = FALSE)

render_reporting_checklist(checklist, responses = NULL)

write_reporting_checklist(
  checklist,
  directory,
  responses = NULL,
  overwrite = FALSE
)

Arguments

id: Stable checklist identifier.
items: Data frame containing item_id, category, label, requirement, and guidance.
version: Checklist version.
title: Human-readable checklist title.
organization: Issuing organization or generic source.
status: Checklist status: generic, verified, or deprecated.
source_url, source_date: Source and verification date for verified checklists.
description: Human-readable description.
x: A PopgenVCFReportingChecklist or written checklist directory.
checklist: A validated PopgenVCFReportingChecklist.
responses: Data frame with item_id, response, and optional evidence and notes.
strict: Whether incomplete required items raise an error.
directory: Parent output directory.
overwrite: Whether an existing output directory may be replaced.

Value

new_reporting_checklist() and generic_reporting_checklist() return a validated PopgenVCFReportingChecklist. validate_reporting_checklist() returns TRUE invisibly. validate_reporting_checklist_responses() returns a deterministic PopgenVCFReportingChecklistReport data table. render_reporting_checklist() returns Markdown lines. write_reporting_checklist() returns the normalized output directory invisibly.