Canonical analysis artifacts and manifests — analysis-artifacts • popgenVCF

Create and validate stable descriptions of files emitted by analysis modules. The artifact manifest separates publication outputs from in-memory statistical results and provides a common interface for reports, provenance, release, and validation tooling.

Usage

new_analysis_artifact(module, name, type, path, format,
  description = "", required = TRUE, metadata = list())

validate_analysis_artifact(artifact, must_exist = FALSE)

new_artifact_manifest(artifacts = list())

register_artifact(manifest, artifact)

validate_artifact_manifest(manifest, must_exist = FALSE)

artifact_manifest_table(manifest)

Arguments

module: Analysis module name.
name: Stable artifact identifier within the module.
type: Artifact type: table, figure, methods, caption, supplementary, validation, provenance, report, or data.
path: Artifact file path.
format: Lowercase file format such as tsv, pdf, svg, png, md, or json.
description: Human-readable artifact description.
required: Whether absence of the artifact invalidates publication output.
metadata: Optional named metadata list.
artifact: A PopgenVCFArtifact.
must_exist: Whether required files must exist on disk.
artifacts: A list of artifacts.
manifest: A PopgenVCFArtifactManifest.

Value

Constructors return artifact or manifest objects. Validators return TRUE invisibly. artifact_manifest_table() returns a data table.

Examples

a <- new_analysis_artifact(
  module = "pca", name = "scores", type = "table",
  path = "tables/pca_scores.tsv", format = "tsv"
)
m <- register_artifact(new_artifact_manifest(), a)
artifact_manifest_table(m)