Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Editing the YAML File

Overview

In the normal practice of curation, only the include rules, exclude rules and metadata overrides need to be edited.  Metadata overrides can only apply to datasets that are included based on the include rules.

Here's an annotated example for the Baseline Population subcategory:

#BASELINE POPULATION
- name: baseline_population
title: Baseline Population
description: Total population aggregated by administrative division.
rules:
include: #adds to the data grid any dataset that matches the country of the data grid (yemen in this case), one or more of the specified tags, and is subnational
- (tags:"population" AND subnational:1)
- (tags:"population statistics" AND subnational:1)
- (tags:"demographics" AND subnational:1)
exclude: # removes from the data grid any datasets matching these tags. Note the last one in this list is not based on tags (see comment in line)
- (tags:"people in need")
- (tags:"people affected")
- (tags:"displaced people")
- (tags:"interally displaced people")
- (tags:"hno")
- (tags:"humanitarian needs overview")
- (tags:"humanitarian needs overview - hno")
- (organization:"worldpop" AND title:" - Population" AND res_format:"zipped geotiff") # removes a specific type of worldpop dataset based on the org name,
# resource format, and a pattern in the dataset title
metadata_overrides: # this section modifies how a particular dataset is displayed in the data grid
- dataset_name: yemen-admin1-combined-food-insecurity-phase-2017-and-population-estimates-2015-2020 #specifies which dataset to modify the display of. It
# must already be included from the 'rules' section above, otherwise this is ignored.
display_state: incomplete # forces the dataset to be displayed with the "hashed" color, not solid blue.
comments: The dataset is only available in a GIS format, and tabular data is preferred for this subcategory. # These comments will appear when
# someone hovers over the dataset in data grid.

The YAML file for each country (and the default YAML file from which they are derived), create a hierarchy:

...