Canonical popgenVCF analysis state — PopgenVCFAnalysis • popgenVCF

Create, validate, inspect, and update the canonical serializable state object used by the popgenVCF pipeline.

Usage

new_popgen_vcf_analysis(config, dirs = NULL)

is_popgen_vcf_analysis(x)

validate_analysis(x, stage = NULL)

set_analysis_result(x, name, value)

get_analysis_result(x, name, default = NULL)

# S3 method for class 'PopgenVCFAnalysis'
print(x, ...)

# S3 method for class 'PopgenVCFAnalysis'
summary(object, ...)

Arguments

config: A validated popgenVCF configuration list.
dirs: Optional output-directory structure.
x, object: A PopgenVCFAnalysis object.
stage: Optional pipeline stage for stronger invariant checks.
name: One result name.
value: A result to store.
default: Value returned when the named result is absent.
...: Additional arguments reserved for methods.

Value

A PopgenVCFAnalysis object, logical scalar, stored result, or one-row summary table, depending on the function.