Indicator Definition Demonstrator

This site contains draft work using JSON Schema to define and document metrics and indicators.

One example is currently available:

Contents

Indicator: Women’s Participation In Training

Indicator Name Women’s Participation in Training
Indicator ID/Code Number X.X
Element/ Theme Social/ Gender
Description Women attending and completing trainings
Metric % of participants that complete trainings who are women
Unit Expressed as percent of total people attending
Report Frequency or Timing Annually, can be updated as needed
Disaggregation Data could be disaggregated by regional or municipality level to reduce naming duplications and to determine potential target or focal areas
Benchmarking UN SDG—5. Gender Equality https://www.un.org/sustainabledevelopment/gender-equality/
Performance Standard A value of 0.5 indicates that the gender gap is zero or close to zero (gender equity).
Limitations Would detail any limitations of the synthesized approach

Indicator definition

This indicator is defined using JSON Schema. The schema pcWomenCompletingTraining2.json can be used to validate this indicator.

Title Description Type Format Required
code string   Required
pcWCT The code for this indicator is pcWCT.
value number   Required
Women completing training (as a percentage of the individuals completing training) The total number of participants completing training whose sex is known, divided by the number of of participants completing training whose sex is ‘Female’.

Indicator calculation

This indicator builds on two other metrics:

  • nPWT - Training: Female participants
  • nTPART - Training: Total Participants

If the bullets above are hyperlinks, you can navigate to find more information on collecting these metrics.

Title Description Type Format Required
numerator object    
Numerator Numerator
numerator/code string    
nPWT The code for this indicator is nPWT
numerator/value number    
Training: Female participants Number of training participants whose sex is female.
denominator object    
Denominator Denominator
denominator/code string    
nTPART The code for this indicator is nTPART
denominator/value number    
Training: total participants Total number of people participating in training.

Dimensions

Title Description Type Format Required
dimensions object    
Dimensions Dimensions uniquely identify a statistical observation, and can also be used to express disaggregated data.
dimensions/periodStart string date Required
Period start When does the period covered by the observation start?
dimensions/periodEnd string date Required
Period end When does the period covered by the observation end?
dimensions/geographicCoverage object    
Geographic coverage The geographic area covered by this observation. A location can be described by either a geometry (point location, line or polygon), or a gazetteer entry, or both.
dimensions/geographicCoverage/description [string]    
Description A name or description of this location. This might include the name(s) of the location(s), or might provide a human readable description of the location to be covered. This description may be used in a user-interface.
dimensions/geographicCoverage/geometry [object]    
Geometry We follow the GeoJSON standard to express basic location information, using latitude and longitude values in the WGS84 (EPSG:4326) projection. A point location can be identified by geocoding a delivery address. For concession licenses, or other contracts covering a polygon location which is not contained in a known gazetteer, polygon and multi-polygon can be used.
dimensions/geographicCoverage/gazetteer [object]    
Gazetteer A gazetteer is a geographical index or directory. The specific gazetteer used should be specified in scheme, and one or more codes from that gazetteer used in identifier.
dimensions/geographicCoverage/uri [string]    
URI A URI to a further description of the location. This may be a human readable document with information on the location, or a machine-readable description of the location.

Attributes

Title Description Type Format Required
attributes object    
Attributes Attributes provide descriptive information about an observation.
attributes/source string    
Source A free text description of the source of this observation
attributes/sourceType string    
Source type What type of source is this? Select one of [‘estimate’, ‘farmerRecall’, ‘officialStatistics’]

Examples

JSON Representation

This data can be represented in JSON in the following structure.

{
    "metrics": [
        {
            "code": "pcWCT",
            "value": 0.3,
            "numerator": {
                "code": "nPWT",
                "value": 3
            },
            "denominator": {
                "code": "nTPART",
                "value": 10
            },
            "dimensions": {
                "periodStartDate": "2017-01-01",
                "periodEndDate": "2018-01-01",
                "geographicCoverage": {
                    "description": "United Kingdom",
                    "gazeteer": {
                        "scheme": "geonames",
                        "identifiers": [
                            "2635167"
                        ]
                    }
                }
            },
            "attributes": {
                "source": "Survey",
                "sourceType": "estimate"
            }
        }
    ]
}
Tabular representation

This data can be represented in tabular form with the following structure.

code value numerator/code numerator/value denominator/code denominator/value dimensions/periodStartDate dimensions/periodEndDate dimensions/geographicCoverage/description dimensions/geographicCoverage/gazeteer/scheme dimensions/geographicCoverage/gazeteer/identifiers attributes/source attributes/sourceType
pcWCT 0.3 nPWT 3 nTPART 10 2017-01-01 2018-01-01 United Kingdom geonames 2635167 Survey estimate
Data entry form (Experimental)

We can generate example data entry forms using the JSON Schema.

This is a static example

ToDo

  • Automatically generate tabular representations of data
  • Factor out dimensions and attributes into their own library