Skip to main content

Resource Validation

In CBIcall, a resource is the external dependency layer used by workflows: third-party tools, reference genomes, known-sites files, interval lists, and auxiliary databases. A run selects one resource key in the parameters YAML:

resource: cbicall-germline-resources-v1

Use this page when the question is: does this resource catalog, selected resource key, or installed resource directory match the workflow I am about to run?

Use Integration Tests when you want to run the shipped example workflows and compare output VCFs.

For the resource model and JSON examples, see Adding Resources. For the current CBIcall-provided bundle, see Bundle v1.

Validate the Catalog

Validate the default catalog:

bin/cbicall validate-resources

Validate one resource key:

bin/cbicall validate-resources --bundle cbicall-germline-resources-v1

Validate a custom catalog:

bin/cbicall validate-resources \
--catalog /path/to/cbicall-resource-catalog.json \
--bundle my-center-germline-v1

This checks the catalog shape and confirms that declared workflow compatibility keys exist.

Validate One Run

Use validate-param with the parameters YAML that will be launched:

bin/cbicall validate-param -p my-center-wes.yaml

This checks the selected resource against the resolved workflow and installed resource metadata when present.

Runtime Provenance

Completed runs record resource provenance in log.json and run-report.json. Compare repeated runs with:

bin/cbicall compare-runs run_a/ run_b/ --output compare-report.txt --html compare-report.html

For adding a new resource entry, see Adding Resources.