Description
Return covered/expected, or zero with defined=false if expected is zero.
Historical and regional records connect source vintages, era coordinates, folio sides, time coverage and locally defined units. Literal tokens and supplied offsets can organize metadata without authenticating an archive or establishing historical calendar equivalence. Preserve the original source and its conventions.
Return covered/expected, or zero with defined=false if expected is zero.
When to use this tool
Use Regional Series Coverage Share when checking the stated regional archival, chronology, coverage or unit convention.
How to use the tool and how it works
- Enter coveredPeriods, expectedPeriods. Use the units and conventions below.
- Run the tool. Correct any format, range, or cross-field input error before interpreting the output.
- Read share, defined. Inspect defined before interpreting the associated values.
Require whole 0<=coveredPeriods<=expectedPeriods. Return covered/expected, or zero with defined=false if expected is zero.1
| Input field | Meaning and units | Accepted input |
|---|---|---|
| coveredPeriods | Covered Periods | Required. Safe integer; minimum 0. |
| expectedPeriods | Expected Periods | Required. Safe integer; minimum 0. |
| Output field | Interpretation | Returned shape |
|---|---|---|
| share | Dimensionless share using the operation-specific denominator stated above; not a percentage number. | Required. Finite number. |
| defined | Whether the corresponding reporting denominator/value is defined; inspect before interpreting zero placeholders. | Required. Boolean. |
{
"input": {
"coveredPeriods": 8,
"expectedPeriods": 10
},
"output": {
"share": 0.8,
"defined": true
}
}Limitations and assumptions
- Periods are equally counted and their identity or overlap is not checked; coverage does not establish source quality.
- Inputs must satisfy both the field types and the cross-field conditions above. Invalid input causes an error; a successful false flag or documented placeholder is a different result.
- Numeric calculations use binary floating point unless exact decimal-integer arithmetic is explicitly stated. No hidden measurement tolerance or decimal rounding is added; nonfinite or out-of-contract results are rejected. Numeric signed-zero results are exported as zero.
Alternative or Complementary methods
Consult the original archive and appropriate historical/calendar/unit authorities for provenance and substantive interpretation.
References
Similar or alternative tools
- Tree Cohort Observation Share
Return observed/eligible, or zero with defined=false when eligible is zero.
- Trial Session Attendance Share
Return attended/planned, or zero with defined=false when planned=0.