Geography Hierarchy Check

Compare caller-supplied expected and observed records for geography hierarchy check.

Description

Geographic label coverage checks whether required place labels appear in observed coverage.

Geographic label coverage checks whether required place labels appear in observed coverage. Its name does not imply validation of geographic ancestry.1

Compare caller-supplied expected and observed records for geography hierarchy check.

When to use Geography Hierarchy Check

Use this tool to compare caller-supplied expected and observed records for geography hierarchy check.

Prepare the text, recorded observations, aligned figures or editorial criteria requested. Confirm what each label, count, timestamp or supplied flag represents before interpreting the result.

How to use Geography Hierarchy Check and understand its results

  1. Prepare the text, recorded observations, aligned figures or editorial criteria requested. Confirm what each label, count, timestamp or supplied flag represents before interpreting the result.
  2. Enter expectedHierarchy, observedHierarchy using the field table and calculation rules, then run the tool.
  3. Read coveragePercent, matched, missing, unexpected. The explanation below defines the units, signs, ordering and any flags or placeholder values.
  4. If the tool reports an input issue, correct the values and run it again. Apply the stated assumptions when interpreting a successfully returned result.
Input fieldMeaningValue type; see rules belowRequirement
expectedHierarchyExpected geographic hierarchylist of stringRequired
observedHierarchyObserved hierarchylist of stringRequired

Supply required and observed geography labels. Enter a nonempty required list and an observed list, which may be empty. Trim and lowercase entries for comparison; blank entries are errors. Deduplicate by normalized key. Return matched/missing required labels, unexpected observed labels, and coverage. Required order is preserved; the last trimmed spelling wins for duplicate keys.

coverage%=100×matchedUnique/requiredUnique

Units, indexing, boundary conditions and exceptional cases are defined in the calculation rules above.

Output fieldMeaningValue type
coveragePercentCoverage (%)number; minimum: 0; maximum: 100
matchedMatched itemslist of string
missingMissing itemslist of string
unexpectedUnexpected itemslist of string
json
{
  "input": {
    "expectedHierarchy": [
      "country",
      "state",
      "county",
      "city"
    ],
    "observedHierarchy": [
      "country",
      "state",
      "city"
    ]
  },
  "output": {
    "coveragePercent": 75,
    "matched": [
      "country",
      "state",
      "city"
    ],
    "missing": [
      "county"
    ],
    "unexpected": []
  }
}

Limitations and assumptions

No parent-child hierarchy, ordering, geocoding or factual location relationship is examined.

Numeric inputs must be finite. Follow the calculation-specific rules for overflow, underflow and exceptional cases. Lists are limited to 100,000 entries; the rules above may require smaller limits. Missing required fields, extra fields, wrong value types and violations of the calculation rules are input errors.

Alternative or Complementary methods

Use Beat Source Coverage: Compare caller-supplied requirements and observations for beat source coverage. For a complementary task, use Election Reporting Coverage: Audit election-reporting topic and source-count coverage.

References

  1. Geography Hierarchy Check — tool.io

Similar or alternative tools

Don't forget to set a bookmark for tool.io!
Privacy | Imprint | Cookies