calculate_population_coverage
Estimate HLA population coverage for supplied peptide-allele associations using an authoritative IEDB service or allowed fixture; use when allele restrictions and population IDs are known.
Instructions
Estimate HLA population coverage for supplied peptide-allele associations using a configured authoritative IEDB service or an explicitly allowed exact fixture. Use when the allele restrictions and population IDs are known; use calculate_synthetic_population_coverage only for demonstrations. LIVE_ONLY requires the live service and the result carries source provenance.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| runId | No | Caller-chosen identifier linking this call to one research run. | interactive-run |
| classMode | No | Whether coverage uses class-I, class-II, or combined associations. | COMBINED |
| associations | Yes | Peptide-to-HLA restrictions used for population coverage calculation. | |
| populationIds | Yes | Population identifiers requested from the coverage source or synthetic dataset. | |
| fallbackPolicy | No | Allowed source order; LIVE_ONLY forbids cache and fixture substitution, FIXTURE_ONLY forbids live calls. | LIVE_THEN_CACHE_THEN_FIXTURE |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ok | Yes | Whether execution completed successfully. | |
| data | No | Tool-specific result fields on success. | |
| meta | Yes | Run identifiers, timings, and input/output hashes. | |
| error | No | Structured failure on unsuccessful execution. |