Olaroti commited on
Commit
36315bd
·
verified ·
1 Parent(s): 39c10a8

Standardize Electric Sheep Africa dataset card

Browse files
Files changed (1) hide show
  1. README.md +113 -90
README.md CHANGED
@@ -1,113 +1,136 @@
1
- # Master Datacard for Water Indicators for African Countries
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
2
 
3
- This repository contains time-series datasets for key water-related indicators for 54 African countries. The data is sourced from The World Bank and has been cleaned, processed, and organized for analysis.
4
 
5
- Each country has its own set of files, including a main CSV dataset and a corresponding datacard in Markdown format. The data covers the period from 1960 to 2024, where available.
6
 
7
- ---
 
 
 
8
 
9
- ## Repository Structure
10
 
11
- The datasets are organized by country. Each country's folder contains:
12
 
13
- 1. A CSV file with the naming convention: `{CountryName}-Water-Indicators-Dataset-{StartYear}-{EndYear}.csv`
14
- 2. A detailed datacard named `datacard_Water.md`.
15
 
16
- ---
17
 
18
- ## Indicators Included
19
 
20
- This collection includes the following water indicators:
21
 
22
- - Annual freshwater withdrawals, total (% of internal resources)
23
- - Marine protected areas (% of territorial waters)
24
- - People using at least basic drinking water services (% of population)
25
- - People with basic handwashing facilities including soap and water (% of population)
 
 
 
 
 
 
 
 
26
 
27
- ---
28
 
29
- ## Countries Included
30
-
31
- This dataset covers all 54 sovereign nations of Africa as recognized by the source data:
32
-
33
- - Algeria
34
- - Angola
35
- - Benin
36
- - Botswana
37
- - Burkina Faso
38
- - Burundi
39
- - Cabo Verde
40
- - Cameroon
41
- - Central African Republic
42
- - Chad
43
- - Comoros
44
- - Congo, Dem. Rep.
45
- - Congo, Rep.
46
- - Cote d'Ivoire
47
- - Djibouti
48
- - Egypt, Arab Rep.
49
- - Equatorial Guinea
50
- - Eritrea
51
- - Eswatini
52
- - Ethiopia
53
- - Gabon
54
- - Gambia, The
55
- - Ghana
56
- - Guinea
57
- - Guinea-Bissau
58
- - Kenya
59
- - Lesotho
60
- - Liberia
61
- - Libya
62
- - Madagascar
63
- - Malawi
64
- - Mali
65
- - Mauritania
66
- - Mauritius
67
- - Morocco
68
- - Mozambique
69
- - Namibia
70
- - Niger
71
- - Nigeria
72
- - Rwanda
73
- - Sao Tome and Principe
74
- - Senegal
75
- - Seychelles
76
- - Sierra Leone
77
- - Somalia
78
- - South Africa
79
- - South Sudan
80
- - Sudan
81
- - Tanzania
82
- - Togo
83
- - Tunisia
84
- - Uganda
85
- - Zambia
86
- - Zimbabwe
87
 
88
- ---
89
 
90
- ## Data Preparation
 
91
 
92
- The raw data from The World Bank was processed using a Python script with the following steps:
 
93
 
94
- 1. **Filtering**: Data was filtered for each of the 54 African countries.
95
- 2. **Reshaping**: Wide-format data (with years as columns) was melted into a long format.
96
- 3. **Merging**: All indicator files for a country were merged into a single time-series dataset based on the 'Year' column.
97
- 4. **Cleaning**: The 'Year' column was converted to a standard date format (`YYYY-MM-DD`).
98
- 5. **Missing Data Handling**: Gaps in the time-series were filled using linear interpolation followed by a back-fill to ensure data continuity.
99
 
100
- ---
101
 
102
- ## How to Use
 
103
 
104
- You can access the data directly through the Hugging Face Hub, either by downloading individual files or by using the `datasets` library to load the data.
 
 
 
 
105
 
106
- ```python
107
- from datasets import load_dataset
108
 
109
- # Example: Load the dataset for Nigeria
110
- dataset = load_dataset('electricsheepafrica/Water-Indicators-For-African-Countries', data_files='Nigeria/Nigeria-Water-Indicators-Dataset-1960-2024.csv')
 
 
111
 
112
- print(dataset)
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
113
  ```
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: other
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
+ - "other-unclassified"
17
+ - "csv"
18
+ - "tabular"
19
+ - "text"
20
+ pretty_name: "Water Indicators For African Countries | Africa (World Health Organization)"
21
+ ---
22
 
23
+ # Water Indicators For African Countries | Africa (World Health Organization)
24
 
25
+ **Size category:** `1K<n<10K` - **Formats:** `csv` - **Sector:** other_unclassified - *Engineered by [Electric Sheep Africa](https://huggingface.co/electricsheepafrica)*
26
 
27
+ ![size](https://img.shields.io/badge/size-1K%3Cn%3C10K-blue)
28
+ ![sector](https://img.shields.io/badge/sector-other_unclassified-green)
29
+ ![downloads](https://img.shields.io/badge/HF_downloads-103-orange)
30
+ ![license](https://img.shields.io/badge/license-other-lightgrey)
31
 
32
+ ## TL;DR
33
 
34
+ 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.
35
 
36
+ ## What This Dataset Covers
 
37
 
38
+ Public datasets help analysts inspect structured evidence, build reproducible workflows, and compare patterns across domains.
39
 
40
+ Dataset context from the existing Hugging Face card: Master Datacard for Water Indicators for African Countries This repository contains time-series datasets for key water-related indicators for 54 African countries. The data is sourced from The World Bank and has been cleaned, processed, and organized for analysis. Each country has its own set of files, including a main CSV dataset and a corresponding datacard in Markdown format. The data covers the period from 1960 to 2024, where available. Repository Structure The… See the full description on the dataset page: https://huggingface.co/datasets/electricsheepafrica/Water-Indicators-For-African-Countries.
41
 
42
+ ## Dataset Profile
43
 
44
+ | Field | Value |
45
+ |---|---|
46
+ | Hugging Face repo | [`electricsheepafrica/Water-Indicators-For-African-Countries`](https://huggingface.co/datasets/electricsheepafrica/Water-Indicators-For-African-Countries) |
47
+ | Sector | other_unclassified |
48
+ | Topic tags | other_unclassified |
49
+ | Modalities | `tabular`, `text` |
50
+ | Formats | `csv` |
51
+ | Size category | `1K<n<10K` |
52
+ | Countries | Africa-wide or source-defined African coverage |
53
+ | ISO3 coverage | `not declared` |
54
+ | Last modified on HF | `2025-06-21 10:17:28+00:00` |
55
+ | Inventory snapshot | `2026-07-16T16:00:34Z` |
56
 
57
+ ## How To Read This Dataset
58
 
59
+ - Start from the repository files and the dataset viewer when available.
60
+ - Treat the README context as a fast orientation layer; confirm variable definitions and units in the data files before modeling.
61
+ - Use explicit country columns when present. When geography is only implied by the title or source metadata, document that assumption in downstream analysis.
62
+ - Preserve missing values until you have a defensible imputation rule.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
63
 
64
+ ## Usage
65
 
66
+ ```python
67
+ from datasets import load_dataset
68
 
69
+ ds = load_dataset("electricsheepafrica/Water-Indicators-For-African-Countries")
70
+ print(ds)
71
 
72
+ split_name = next(iter(ds))
73
+ table = ds[split_name]
74
+ print(table.features)
75
+ print(table[:3])
76
+ ```
77
 
78
+ ### Convert To Pandas When Tabular
79
 
80
+ ```python
81
+ from datasets import Dataset
82
 
83
+ first_split = ds[next(iter(ds))]
84
+ if isinstance(first_split, Dataset):
85
+ df = first_split.to_pandas()
86
+ print(df.head())
87
+ ```
88
 
89
+ ## Data Quality Notes
 
90
 
91
+ - This card was standardized from the Electric Sheep Africa Hugging Face metadata inventory.
92
+ - Exact schema, row counts, and source files should be inspected in the repository data files.
93
+ - Metadata gaps from the inventory: country, sector, upstream_publisher, license, language.
94
+ - Do not infer policy meaning from labels alone; confirm definitions, units, and methods in the source material.
95
 
96
+ ## Source And Provenance
97
+
98
+ - **Source context:** World Health Organization
99
+ - **Publisher/source attribution:** WHO public data
100
+ - **License:** Source-specific or other license
101
+ - **Hugging Face URL:** [https://huggingface.co/datasets/electricsheepafrica/Water-Indicators-For-African-Countries](https://huggingface.co/datasets/electricsheepafrica/Water-Indicators-For-African-Countries)
102
+ - **Inventory retrieved at:** `2026-07-16T16:00:34Z`
103
+
104
+ ## Suggested Analyses
105
+
106
+ - Inspect schema and missingness before modeling.
107
+ - Profile variables by geography, time, and subgroup columns where present.
108
+ - Join with other Electric Sheep Africa datasets using explicit country, year, and indicator fields when available.
109
+ - Build reproducible notebooks that cite both the original source context and the Electric Sheep Africa Hugging Face repo.
110
+
111
+ ## Citation
112
+
113
+ ```bibtex
114
+ @misc{electric_sheep_africa_water_indicators_for_african_countries_2026,
115
+ title = {Water Indicators For African Countries | Africa (World Health Organization)},
116
+ author = {WHO public data},
117
+ year = {2026},
118
+ url = {https://huggingface.co/datasets/electricsheepafrica/Water-Indicators-For-African-Countries},
119
+ publisher = {Hugging Face Datasets, engineered by Electric Sheep Africa},
120
+ howpublished = {\url{https://huggingface.co/datasets/electricsheepafrica/Water-Indicators-For-African-Countries}}
121
+ }
122
  ```
123
+
124
+ ## License
125
+
126
+ Released under Source-specific or other license.
127
+
128
+ 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.
129
+
130
+ ## About Electric Sheep Africa
131
+
132
+ Electric Sheep Africa publishes ML-ready African public datasets on Hugging Face.
133
+
134
+ ---
135
+
136
+ Provenance: metadata-backed README standardized 2026-08-12 by the Electric Sheep Africa README system. Inventory source: `catalog/esa_metadata_inventory/master_metadata.jsonl`.