generated from open-sdg/open-sdg-data-starter
-
Notifications
You must be signed in to change notification settings - Fork 1
/
config_data.yml
138 lines (127 loc) · 5.71 KB
/
config_data.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
# This config file is for use with the `build_data` and `check_data` functions,
# which are helpers for implementations of Open SDG. This file allows easy use
# of those functions without altering Python code.
# Languages
# ---------
# This tells sdg-build to perform "translated builds" for each of the specified
# languages. Each build is in its own subfolder - one for each language.
languages:
- en
- es
# Destination directory
# ---------------------
# This identifies a directory to hold the "built" files. The default is '_site'.
site_dir: _site
# Schema file
# -----------
# This identifies a file containing the schema (possible fields) for metadata.
# Currently this needs to be a prose.io config, and defaults to '_prose.yml'.
schema_file: metadata_schema.yml
# Source directory
# ----------------
# This identifies the directory that holds the 'data' and 'meta' folders.
# The default, '', points to the root of this repository.
src_dir: ''
# Inputs
# ------
# The allows control over the inputs of data and metadata. This can be omitted
# if you are using the standard Open SDG approach of CSV data and YAML metadata.
# But if you would like to use non-standard inputs (such as SDMX) then you can
# use this as needed.
#
# Each item must have a "class" which corresponds to classes in the sdg/inputs
# folder. Further, each item can have any/all of the parameters that class uses.
# The defaults below show what is used when this is omitted.
inputs:
- class: InputCsvData
# This describes the data files, relative to the "src_dir" indicated above.
path_pattern: data/*-*.csv
- class: InputYamlMeta
path_pattern: indicator-config/*-*.yml
git: false
- class: InputYamlMeta
# This describes the meta files, relative to the "src_dir" indicated above.
path_pattern: meta/*-*.yml
# This specifies whether or not to use Git to calculate the "last updated"
# dates for data files.
git: true
# This specifies an alternate folder to look in for Git-versioned data files,
# when calculating the "last updated" dates for data files. This defaults to
# "data" (the folder where the data files actually exist.) Most sites will not
# need to change this setting. It is intended for sites where the data needs
# to be "built" before being processed by sdg-build.
git_data_dir: data
- class: InputSdmxMeta
meta_suffix: __GLOBAL
# Translations
# ------------
# The allows control over the imported translations. This can be omitted if you
# are happy with the defaults. But if you are using custom translation repos
# or non-standard inputs (such as SDMX) then you can use this as needed.
#
# Each item must have a "class" which corresponds to classes in the sdg-build
# project. Further, each item can have any/all of the parameters that class uses.
# The defaults below show what is used when this is omitted.
translations:
# This pulls in translations from a Git repository.
- class: TranslationInputSdgTranslations
source: https://github.com/open-sdg/sdg-translations.git
tag: 2.3.0
# This pulls in translations from a local 'translations' folder.
- class: TranslationInputYaml
source: translations
# Reporting status extra fields
# -----------------------------
# This allows the build to generate stats for reporting status by additional
# fields, beyond the default "status by goal" report.
reporting_status_extra_fields: []
# Map layers
# ----------
# This allows the build to generate one or more GeoJSON files to be used by
# Open SDG maps. The parameters available correspond to the OutputGeoJson class.
# See sdg/outputs/OutputGeoJson.py for more information. Uncomment the map_layers
# below and adjust if you would like to use the Open SDG mapping functionality.
# Note that the GeoJSON files can either be remote (as in the example below) or
# local, relative to the src_dir specified above.
#map_layers:
# - geojson_file: https://geoportal1-ons.opendata.arcgis.com/datasets/4fcca2a47fed4bfaa1793015a18537ac_4.geojson
# name_property: rgn17nm
# id_property: rgn17cd
# output_subfolder: regions
# filename_prefix: indicator_
# Documentation settings
# ----------------------
# This controls the automatic documentation that is created for your build.
#
# This is the logo at the top of the automated documentation pages.
docs_branding: SDG data build documentation
# This displays at the top of the automated documentation homepage.
docs_intro: This is a list of examples of endpoints and output that are
available on this service. Click each of the links below for more information
on the available output.
# This can be uncommented and updated so allow links to your indicator pages.
# The URL here should have [id] instead of the indicator ID.
#docs_indicator_url: https://my-github-org/my-site-repository/[id]
# This can be uncommented to show translation columns in the disaggregation report.
#docs_translate_disaggregations: true
# This can be uncommented to show additional columns in the disaggregation report.
# This is mainly intended to show units of measurement and series, which are not
# normally considered "disaggregation".
# docs_extra_disaggregations: ['Units', 'Series']
# This controls the metadata report which is part of the automatic documentation.
# More info can be found at https://open-sdg.readthedocs.io/en/latest/data-configuration/#docs_metadata_fields
docs_metadata_fields:
- key: reporting_status
label: Reporting status
- key: SDG_CUSTODIAN_AGENCIES__GLOBAL
label: UN custodian agency
- key: data_non_statistical
label: Non-statistical
- key: data_show_map
label: Show map
- key: national_geographical_coverage
label: Geographical coverage
- key: computation_units
label: Units
- key: graph_type
label: Graph type