Olaroti commited on
Commit
197d6a7
·
verified ·
1 Parent(s): f608427

Standardize Electric Sheep Africa dataset card

Browse files
Files changed (1) hide show
  1. README.md +102 -76
README.md CHANGED
@@ -1,113 +1,139 @@
1
  ---
2
  license: cc-by-4.0
3
- task_categories:
4
- - tabular-classification
5
- - tabular-regression
6
  language:
7
- - en
8
- tags:
9
- - africa
10
- - health
11
- - who
12
- - gho
13
- - "fps"
14
- pretty_name: "Africa — WHO GHO: Demand for family planning satisfied - modern and traditional methods (%)"
15
  size_categories:
16
- - 1K<n<10K
 
 
 
 
 
 
 
 
 
 
 
 
 
17
  ---
18
 
19
- # Africa — WHO GHO: Demand for family planning satisfied - modern and traditional methods (%)
20
 
21
- **Indicator code:** `fps`
22
- **HuggingFace slug:** `electricsheepafrica/africa-who-demand-for-family-planning-satisfied-modern-and-traditional`
23
- **Source:** [WHO Global Health Observatory](https://www.who.int/data/gho/data/indicators/indicator-details/GHO/fps)
24
- **License:** [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/) — WHO Open Data
25
 
26
- ---
 
 
 
27
 
28
- ## Dataset Description
29
 
30
- This dataset contains country-level observations for the WHO GHO indicator **"Demand for family planning satisfied - modern and traditional methods (%)"** (`fps`) across African nations, spanning 1993–2019. It is part of the [Electric Sheep Africa](https://huggingface.co/electricsheepafrica) collection a unified, ML-ready repository of African data.
31
 
32
- Data is sourced directly from the WHO Global Health Observatory OData API and repackaged as Parquet files with a consistent schema. All values are drawn from `NumericValue` (the float-precision field), not the display string. Confidence interval bounds (`value_low`, `value_high`) are included where available.
33
 
34
- ---
35
 
36
- ## Coverage
37
 
38
- | | |
39
- |---|---|
40
- | **Countries** | 40 African nations |
41
- | **Years** | 1993 – 2019 |
42
- | **Total rows** | 5,528 |
43
- | **Region filter** | WHO AFRO (`ParentLocationCode = 'AFR'`) |
44
 
45
- **Countries included:** AGO, BDI, BEN, BFA, CAF, CIV, CMR, COD, COG, COM, DZA, ETH, GAB, GHA, GIN, GMB, GNB, KEN, LBR, LSO … and 20 more
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
46
 
47
- ---
48
 
49
- ## Sub-dimensions
 
50
 
51
- - **AGEGROUP**: AGEGROUP_YEARS15-19, AGEGROUP_YEARS20-49
52
- - **DHSMICSGEOREGION**: DHSMICSGEOREGION_AGODHS201501, DHSMICSGEOREGION_AGODHS201502, DHSMICSGEOREGION_AGODHS201503, DHSMICSGEOREGION_AGODHS201504, DHSMICSGEOREGION_AGODHS201505, DHSMICSGEOREGION_AGODHS201506, DHSMICSGEOREGION_AGODHS201507, DHSMICSGEOREGION_AGODHS201508, DHSMICSGEOREGION_AGODHS201509, DHSMICSGEOREGION_AGODHS201510 …
53
- - **EDUCATIONLEVEL**: EDUCATIONLEVEL_NHLM, EDUCATIONLEVEL_PRLM, EDUCATIONLEVEL_SHLM
54
- - **RESIDENCEAREATYPE**: RESIDENCEAREATYPE_RUR, RESIDENCEAREATYPE_URB
55
- - **WEALTHDECILE**: WEALTHDECILE_WEALTHDECILE01, WEALTHDECILE_WEALTHDECILE02, WEALTHDECILE_WEALTHDECILE03, WEALTHDECILE_WEALTHDECILE04, WEALTHDECILE_WEALTHDECILE05, WEALTHDECILE_WEALTHDECILE06, WEALTHDECILE_WEALTHDECILE07, WEALTHDECILE_WEALTHDECILE08, WEALTHDECILE_WEALTHDECILE09, WEALTHDECILE_WEALTHDECILE10
56
- - **WEALTHQUINTILE**: WEALTHQUINTILE_WQ1, WEALTHQUINTILE_WQ2, WEALTHQUINTILE_WQ3, WEALTHQUINTILE_WQ4, WEALTHQUINTILE_WQ5
57
 
58
- When an indicator is stratified (e.g., by sex or age group), each unique combination of country × year × dimension produces a separate row. Filter on `dim1` / `dim2` for the stratum you need, or aggregate across strata.
 
 
 
 
59
 
60
- ---
61
 
62
- ## Schema
63
-
64
- | Column | Type | Description |
65
- |--------|------|-------------|
66
- | `indicator_code` | string | GHO indicator code (e.g., `fps`) |
67
- | `country_iso3` | string | ISO 3166-1 alpha-3 country code |
68
- | `who_region` | string | WHO region code (always `AFR` here) |
69
- | `year` | int | Observation year |
70
- | `value_numeric` | float | Point estimate (primary ML target) |
71
- | `value_low` | float | Lower confidence bound (if available) |
72
- | `value_high` | float | Upper confidence bound (if available) |
73
- | `value_display` | string | Formatted display string, e.g. `"58.3 [57.7–59.0]"` |
74
- | `dim1_type` | string | Dimension 1 type, e.g. `SEX`, `RESIDENCEAREATYPE` |
75
- | `dim1` | string | Dimension 1 value, e.g. `SEX_BTSX`, `RURAL` |
76
- | `dim2_type` | string | Dimension 2 type (if present) |
77
- | `dim2` | string | Dimension 2 value (if present) |
78
- | `last_updated` | string | WHO data last-updated timestamp |
79
 
80
- ---
 
 
 
 
81
 
82
- ## Usage
83
 
84
- ```python
85
- from datasets import load_dataset
 
 
86
 
87
- ds = load_dataset("electricsheepafrica/africa-who-demand-for-family-planning-satisfied-modern-and-traditional")
88
- df = ds["train"].to_pandas()
89
 
90
- # Both-sexes, national level only
91
- national = df[df.get("dim1", "").str.endswith("_BTSX") | df.get("dim1", pd.Series()).isna()]
 
 
 
92
 
93
- # Time series for one country
94
- kenya = df[df["country_iso3"] == "KEN"].sort_values("year")
95
- ```
96
 
97
- ---
 
 
 
98
 
99
  ## Citation
100
 
101
  ```bibtex
102
- @misc{who_gho_fps,
103
- title = {WHO Global Health Observatory: Demand for family planning satisfied - modern and traditional methods (%)},
104
- author = {World Health Organization},
105
- year = {2019},
106
- url = {https://www.who.int/data/gho/data/indicators/indicator-details/GHO/fps},
107
- note = {Repackaged by Electric Sheep Africa}
 
108
  }
109
  ```
110
 
 
 
 
 
 
 
 
 
 
 
111
  ---
112
 
113
- _Repackaged by [Electric Sheep Africa](https://huggingface.co/electricsheepafrica) from WHO GHO open data. Original data © World Health Organization, licensed CC BY 4.0._
 
1
  ---
2
  license: cc-by-4.0
 
 
 
3
  language:
4
+ - en
5
+ task_categories:
6
+ - tabular-classification
7
+ - tabular-regression
8
+ multilinguality: monolingual
 
 
 
9
  size_categories:
10
+ - 1K<n<10K
11
+ tags:
12
+ - "africa"
13
+ - "electric-sheep-africa"
14
+ - "open-data"
15
+ - "metadata-backed"
16
+ - "health"
17
+ - "parquet"
18
+ - "tabular"
19
+ - "text"
20
+ - "who"
21
+ - "gho"
22
+ - "fps"
23
+ pretty_name: "Africa — WHO GHO: Demand for family planning satisfied - modern and traditional methods (%) | Africa (World Health Organization)"
24
  ---
25
 
26
+ # Africa — WHO GHO: Demand for family planning satisfied - modern and traditional methods (%) | Africa (World Health Organization)
27
 
28
+ **Size category:** `1K<n<10K` - **Formats:** `parquet` - **Sector:** health - *Engineered by [Electric Sheep Africa](https://huggingface.co/electricsheepafrica)*
 
 
 
29
 
30
+ ![size](https://img.shields.io/badge/size-1K%3Cn%3C10K-blue)
31
+ ![sector](https://img.shields.io/badge/sector-health-green)
32
+ ![downloads](https://img.shields.io/badge/HF_downloads-21-orange)
33
+ ![license](https://img.shields.io/badge/license-cc--by--4.0-lightgrey)
34
 
35
+ ## TL;DR
36
 
37
+ This dataset is part of the Electric Sheep Africa catalog on Hugging Face. It is indexed for African data discovery with standardized metadata, loading guidance, provenance notes, and analyst-oriented context.
38
 
39
+ ## What This Dataset Covers
40
 
41
+ Health datasets help researchers examine disease burden, service delivery, risk factors, outcomes, and public-health program performance.
42
 
43
+ Dataset context from the existing Hugging Face card: Africa — WHO GHO: Demand for family planning satisfied - modern and traditional methods (%) Indicator code: fps HuggingFace slug: electricsheepafrica/africa-who-demand-for-family-planning-satisfied-modern-and-traditional Source: WHO Global Health Observatory License: CC BY 4.0 — WHO Open Data Dataset Description This dataset contains country-level observations for the WHO GHO indicator "Demand for family planning satisfied - modern and traditional methods (%)" (fps)… See the full description on the dataset page: https://huggingface.co/datasets/electricsheepafrica/africa-who-demand-for-family-planning-satisfied-modern-and-traditional.
44
 
45
+ ## Dataset Profile
 
 
 
 
 
46
 
47
+ | Field | Value |
48
+ |---|---|
49
+ | Hugging Face repo | [`electricsheepafrica/africa-who-demand-for-family-planning-satisfied-modern-and-traditional`](https://huggingface.co/datasets/electricsheepafrica/africa-who-demand-for-family-planning-satisfied-modern-and-traditional) |
50
+ | Sector | health |
51
+ | Topic tags | health, who, gho, fps |
52
+ | Modalities | `tabular`, `text` |
53
+ | Formats | `parquet` |
54
+ | Size category | `1K<n<10K` |
55
+ | Countries | Africa-wide or source-defined African coverage |
56
+ | ISO3 coverage | `not declared` |
57
+ | Last modified on HF | `2026-05-02 13:17:26+00:00` |
58
+ | Inventory snapshot | `2026-07-16T16:00:34Z` |
59
+
60
+ ## How To Read This Dataset
61
+
62
+ - Start from the repository files and the dataset viewer when available.
63
+ - Treat the README context as a fast orientation layer; confirm variable definitions and units in the data files before modeling.
64
+ - Use explicit country columns when present. When geography is only implied by the title or source metadata, document that assumption in downstream analysis.
65
+ - Preserve missing values until you have a defensible imputation rule.
66
 
67
+ ## Usage
68
 
69
+ ```python
70
+ from datasets import load_dataset
71
 
72
+ ds = load_dataset("electricsheepafrica/africa-who-demand-for-family-planning-satisfied-modern-and-traditional")
73
+ print(ds)
 
 
 
 
74
 
75
+ split_name = next(iter(ds))
76
+ table = ds[split_name]
77
+ print(table.features)
78
+ print(table[:3])
79
+ ```
80
 
81
+ ### Convert To Pandas When Tabular
82
 
83
+ ```python
84
+ from datasets import Dataset
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
85
 
86
+ first_split = ds[next(iter(ds))]
87
+ if isinstance(first_split, Dataset):
88
+ df = first_split.to_pandas()
89
+ print(df.head())
90
+ ```
91
 
92
+ ## Data Quality Notes
93
 
94
+ - This card was standardized from the Electric Sheep Africa Hugging Face metadata inventory.
95
+ - Exact schema, row counts, and source files should be inspected in the repository data files.
96
+ - Metadata gaps from the inventory: country, upstream_publisher.
97
+ - Do not infer policy meaning from labels alone; confirm definitions, units, and methods in the source material.
98
 
99
+ ## Source And Provenance
 
100
 
101
+ - **Source context:** World Health Organization
102
+ - **Publisher/source attribution:** WHO public data
103
+ - **License:** [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/)
104
+ - **Hugging Face URL:** [https://huggingface.co/datasets/electricsheepafrica/africa-who-demand-for-family-planning-satisfied-modern-and-traditional](https://huggingface.co/datasets/electricsheepafrica/africa-who-demand-for-family-planning-satisfied-modern-and-traditional)
105
+ - **Inventory retrieved at:** `2026-07-16T16:00:34Z`
106
 
107
+ ## Suggested Analyses
 
 
108
 
109
+ - Inspect schema and missingness before modeling.
110
+ - Profile variables by geography, time, and subgroup columns where present.
111
+ - Join with other Electric Sheep Africa datasets using explicit country, year, and indicator fields when available.
112
+ - Build reproducible notebooks that cite both the original source context and the Electric Sheep Africa Hugging Face repo.
113
 
114
  ## Citation
115
 
116
  ```bibtex
117
+ @misc{electric_sheep_africa_africa_who_demand_for_family_planning_satisfied_modern_and_traditional_2026,
118
+ title = {Africa WHO GHO: Demand for family planning satisfied - modern and traditional methods (%) | Africa (World Health Organization)},
119
+ author = {WHO public data},
120
+ year = {2026},
121
+ url = {https://huggingface.co/datasets/electricsheepafrica/africa-who-demand-for-family-planning-satisfied-modern-and-traditional},
122
+ publisher = {Hugging Face Datasets, engineered by Electric Sheep Africa},
123
+ howpublished = {\url{https://huggingface.co/datasets/electricsheepafrica/africa-who-demand-for-family-planning-satisfied-modern-and-traditional}}
124
  }
125
  ```
126
 
127
+ ## License
128
+
129
+ Released under [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/).
130
+
131
+ Original source rights remain with the original publisher or data provider. Electric Sheep Africa engineering standardizes discovery metadata, documentation, and usage guidance for analysis on Hugging Face.
132
+
133
+ ## About Electric Sheep Africa
134
+
135
+ Electric Sheep Africa publishes ML-ready African public datasets on Hugging Face.
136
+
137
  ---
138
 
139
+ Provenance: metadata-backed README standardized 2026-08-12 by the Electric Sheep Africa README system. Inventory source: `catalog/esa_metadata_inventory/master_metadata.jsonl`.