This document is intended as a collection of procedures and resources to guide the curation of Data Completeness instances (henceforth, Data Grids) which can be activated for any location page on HDX (by a sysadmin). This document and others linked from it, should evolve to capture best practices and any other useful info leanred learned as the data grid curators do their work.
...
- Procedure document (this document)
- Data Completeness Definitions Document
- Quality Checklist (below)
- YAML editing examples (below)
- Github Repository
- YAML Validator
- Data grids overview dashboard
Process Overview
The basic curation process is outlined below:
...
There may be more on the feature server for testing purposes, but the ones listed below should be the only active ones on the production server.
Country | Production Data Grid | Feature Server Data Grid | Curator(s) | Last check date |
---|---|---|---|---|
Yemen | Production: yem | Feature: yem | Amadu | 26 April 2019 |
Sudan | Production: sdn | Feature: sdn | Meti | |
Indonesia | Production: idn | Feature: idn | Faizal | 26 April 2019 |
Somalia | Production: som | Feature: som | Meti | 26 April 2019 |
Colombia | Production: col | Feature: col | Amadu | |
Philippines | Production: phl | Feature: phl | Amadu | 26 April 2019 |
Afghanistan | Production: afg | Feature: afg | Meti | |
Bangladesh | Production: bgd | Feature: bgd | Faizal | |
Chad | Production: tcd | Feature: tcd | Nafi | |
Mozambique | Production: moz | Feature: moz | Obadah | 26 April 2019 |
Venezuela | Production: ven | Feature: ven | Joseph | |
Democratic Repubic of the Congo | Production: cod | Feature: cod | Joseph | |
Central African Republic | Production: caf | Feature: caf | Nafi | |
Myanmar | Production: mmr | Feature: mmr | Obadah |
Quality Checks Process
Each dataset that is a candidate for data grid has to be evaluated to determine if it fully meets the requirements to be included, partially meets the requirements, or does not meet them at all. The outcome determines what actions have to be taken in the YAML file to inlcude or exclude the file, and any comments to be recorded for users to understand where the dataset falls short. Below the process diagram, you will find more details on each quality check.
...
- Dataset does not appear to cover all admin X units and is therefore assumed to be incomplete.
- Dataset covers a limited area.
- Some "no data" values occur, but the meaning of these values not defined in the metadata.
- It is not clear from metadata if this dataset attempts comprehensive coverage and is therefore assumed to be incomplete.
- Dataset is not considered complete by its contributor.
- OpenStreetMap data relies on user contributions and may not be comprehensive for all areas. Dataset does not always contain data about practicability of a road.
- Dataset is limited to captials of administrative divsions.
Are location references explicit in the resource or joinable to an available location reference that also appears in the data grid?
...
- A top level Data Grid element which has
- One or more Category Elements (like "Admnistration" or "Population and Socio-Economic") which have
- One or more Subcategory Elements (like "Administrative Divisions" or "Populated Places") which have
- A set of rules for including and excluding datasets based on tags, dataset names, or any other query which hassupported by solr. These rules are in the format of an fq query and therefore can be tested using the hdx site. For example to test the include rule (tags:"populated places" AND sunbnational:1) for Indonesia, use https://data.humdata.org/search?fq=(tags:"populated places" AND subnational:1 AND groups:idn)
- One or more include rules which specify one or more queries the results of which will be added to the data grid. These rules are in the format of an fq query and therefore can be tested using the hdx site. For example to test
- Zero or more exclude rules which specity datasets that should not be allowed in the data grid
- A set of metadata overrides which refer to datasets already included by the rules and define how they are displayed and comments that are displayed along with them.
- A set of rules for including and excluding datasets based on tags, dataset names, or any other query which hassupported by solr. These rules are in the format of an fq query and therefore can be tested using the hdx site. For example to test the include rule (tags:"populated places" AND sunbnational:1) for Indonesia, use https://data.humdata.org/search?fq=(tags:"populated places" AND subnational:1 AND groups:idn)
- One or more Subcategory Elements (like "Administrative Divisions" or "Populated Places") which have
- One or more Category Elements (like "Admnistration" or "Population and Socio-Economic") which have
...