Canonical module plugin descriptor — new_module

Constructs and validates the versioned public contract used by analysis modules registered with the popgenVCF execution runtime.

Usage

new_module_plugin(
  id,
  version,
  dependencies = character(),
  inputs = character(),
  outputs,
  execute,
  validate,
  lifecycle = "experimental",
  deterministic = TRUE,
  schema_version = 1L
)

Arguments

id: Stable lower-case module identifier.
version: Semantic module version.
dependencies: Character vector of module identifiers.
inputs: Character vector of declared input object types.
outputs: Character vector of declared output artifact types.
execute: Name of the execution entry point.
validate: Name of the result-validation entry point.
lifecycle: One of `stable`, `experimental`, or `deprecated`.
deterministic: Whether equivalent inputs and configuration must yield scientifically equivalent canonical results.
schema_version: Plugin contract schema version.

Value

A validated `popgen_module_plugin` descriptor.