logannye/Rosalind deterministic analysis contract
Plan, govern, verify, and retain a deterministic per-locus genomics artifact.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| index | Legacy .idx reference. Exactly one of index/reference-pack is required. | no | "" |
| reference-pack | Preferred .rref analysis reference. Exactly one of reference-pack/index is required. | no | "" |
| alignments | Path to a coordinate-sorted BAM. | yes | — |
| budget-mb | Declared memory budget in MiB. The run is refused up front (exit 3) or fails after (exit 4) if the realized peak exceeds it. | yes | — |
| max-depth | Active-set depth cap (the bound the contract relies on). 0 = uncapped (then --enforce is rejected). | no | 1000 |
| max-read-len | Maximum read length assumed and enforced at ingest under --enforce. | no | 250 |
| output | Primary artifact path. | no | calls.vcf |
| analyzer | variants, features, or coverage. | no | variants |
| format | Feature output format: tsv or arrow-ipc. | no | tsv |
| region | Optional samtools-style region. | no | "" |
| regions | Optional BED path. | no | "" |
| shard-count | Optional deterministic shard count. | no | "" |
| shard-index | Optional zero-based deterministic shard index. | no | "" |
| require-os-limit | Require an existing cgroup-v2 limit at or below the budget. | no | false |
| reproduce | Rerun and emit a reproduction certificate (doubles analysis work). | no | false |
| artifact-name | Uploaded evidence bundle name. | no | rosalind-receipt |
| version | Rosalind release to download (e.g. v0.1.0), or "latest". Ignored if binary-path is set. | no | latest |
| binary-path | Optional path to an existing rosalind binary (skips the download — for air-gapped runners or testing the action against a from-source build). | no | "" |
Outputs
no outputs