Standardize Electric Sheep Africa dataset card

README.md

@@ -5,86 +5,109 @@ language:
 task_categories:
 - tabular-classification
 - tabular-regression
-multilinguality: monolingual
+multilinguality: multilingual
 size_categories:
 - 1K<n<10K
 tags:
-- tabular
-- csv
-- africa
-- chad
-- official-statistics
-- open-data
+- "tabular"
+- "africa"
+- "open-data"
+- "official-statistics"
+- "chad"
+- "eth-zurich-weather-and-climate-risks"
+- "afg"
+- "bfa"
+- "bdi"
+- "cmr"
+- "caf"
+- "tcd"
+- "col"
+- "cod"
 configs:
 - config_name: default
   data_files:
   - split: train
     path: data/train-00000-of-00001.parquet
-pretty_name: "LitPop: Humanitarian Response Plan (HRP) Countries Exposure Data for Disaster Risk Assessment | Africa (Chad official open data)"
+pretty_name: "Litpop Humanitarian Response Plan Hrp Countries Exposure D | Africa (ETH Zürich - Weather and Climate Risks)"
 ---
 
-# LitPop: Humanitarian Response Plan (HRP) Countries Exposure Data for Disaster Risk Assessment | Africa (Chad official open data)
+# Litpop Humanitarian Response Plan Hrp Countries Exposure D | Africa (ETH Zürich - Weather and Climate Risks)
 
-1,313 rows - 1 Africa country - not-applicable - Repackaged by [Electric Sheep Africa](https://huggingface.co/electricsheepafrica)
+**1,313 rows** - **1 Africa country/area** - **detected** - **source table** - *Engineered by [Electric Sheep Africa](https://huggingface.co/electricsheepafrica)*
 
 ![rows](https://img.shields.io/badge/rows-1313-blue)
 ![countries](https://img.shields.io/badge/countries-1-green)
-![years](https://img.shields.io/badge/years-not-applicable-orange)
+![period](https://img.shields.io/badge/period-detected-orange)
 ![indicators](https://img.shields.io/badge/indicators-0-purple)
-![license](https://img.shields.io/badge/license-cc-by-4.0-lightgrey)
+![license](https://img.shields.io/badge/license-cc--by--4.0-lightgrey)
 
 ## TL;DR
 
-This dataset packages one official `CSV` resource from **Chad** as
-ML-ready Parquet. The source file is the provenance boundary; all usable
-indicators or tabular columns from the resource stay together in this repo.
+This dataset contains **1,313 rows** from **ETH Zürich - Weather and Climate Risks**, covering **Litpop Humanitarian Response Plan Hrp Countries Exposure D**. It is published as ML-ready Parquet with consistent Hugging Face metadata, source provenance, and analysis-friendly loading examples.
 
-## About the source
+## What This Dataset Measures
 
-- **Source:** [LitPop: Humanitarian Response Plan (HRP) Countries Exposure Data for Disaster Risk Assessment](https://data.humdata.org/dataset/climada-litpop-dataset)
-- **Publisher:** ETH Zürich - Weather and Climate Risks
-- **Resource:** [haiti-admin1-litpop.csv](https://data.humdata.org/dataset/3527869c-8fe9-4289-9d57-1811e789bf60/resource/2d3c933d-1fa0-4689-b383-83c519dc2852/download/haiti-admin1-litpop.csv)
-- **Format:** `CSV`
-- **License:** [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/)
-- **Packaging mode:** `tabular_resource`
+Official statistics datasets help analysts inspect public data as published by governments, national statistical systems, and regional data portals.
+
+Source-provided context: Gridded LitPop data for Haiti with admin1 name column
+
+## How To Read This Dataset
+
+- **One row means:** one source record from the original tabular resource, with Electric Sheep Africa provenance columns added where available.
+- **Primary geography column:** `country_iso3`.
+- **Best time column:** `source_period_start_year`.
+- **Time coverage basis:** source_period_start_year.
+- **Recommended join keys:** `country_iso3` where available plus source-specific keys.
+
+## Coverage
+
+| Dimension | Value |
+|---|---:|
+| Rows | 1,313 |
+| Countries/areas | 1 |
+| First period | detected |
+| Last period | detected |
+| Indicators | 0 |
+| Columns | 21 |
+| Source format | CSV |
 
-## Geographic coverage
+## Geographic Coverage
 
-1 Africa country:
+Top areas shown below, sorted by row count when available:
 
-| Country | Rows | First year | Last year | Name |
-|---------|-----:|-----------:|----------:|------|
-| `TCD` | 1,313 | n/a | n/a | `Chad` |
+| Area | Rows | First year | Last year | Name |
+|------|-----:|-----------:|----------:|------|
+| `TCD` | 1,313 | detected | detected | `Chad` |
 
-## Indicators or Resource Contents
+## Indicators, Variables, Or Resource Contents
 
-- This source file is packaged as a normalized tabular resource.
+- This repo preserves one source tabular resource with its usable columns kept together.
 
 ## Schema
 
 | Column | Type | Description | Example |
 |--------|------|-------------|---------|
-| `source_record_id` | `string` | Stable row identifier for tabular resources. | `2d3c933d-1fa0-4689-b383-83c519dc2852:0` |
-| `country_iso3` | `category` | ISO3 country code. | `TCD` |
-| `country_name` | `category` | Country name. | `Chad` |
-| `country_name_2` | `string` | Source column. | `#country` |
-| `admin1_name` | `string` | Source column. | `#adm1+name` |
-| `latitude` | `float64` | Source column. | `` |
-| `longitude` | `float64` | Source column. | `` |
-| `aggregation` | `string` | Source column. | `` |
-| `indicator` | `string` | Source column. | `#indicator+name` |
-| `value` | `float64` | Numeric observation value. | `` |
-| `source_period_start_year` | `Int64` | First year inferred from source resource metadata. | `` |
-| `source_period_end_year` | `Int64` | Last year inferred from source resource metadata. | `` |
-| `source_period_label` | `string` | Human-readable period inferred from source resource metadata. | `` |
-| `source_provider` | `category` | Publishing organization. | `ETH Zürich - Weather and Climate Risks` |
-| `source_dataset` | `category` | Source package title. | `LitPop: Humanitarian Response Plan (HRP) Countries Exposure Data for Dis` |
-| `source_resource` | `category` | Source resource title. | `haiti-admin1-litpop.csv` |
-| `source_package_id` | `category` | CKAN package UUID. | `3527869c-8fe9-4289-9d57-1811e789bf60` |
-| `source_resource_id` | `category` | CKAN resource UUID. | `2d3c933d-1fa0-4689-b383-83c519dc2852` |
-| `source_url` | `category` | Original source resource URL. | `https://data.humdata.org/dataset/3527869c-8fe9-4289-9d57-1811e789bf60/re` |
-| `license_id` | `category` | Source license identifier. | `cc-by` |
-| `retrieved_at` | `category` | UTC retrieval timestamp. | `2026-08-10T22:51:43Z` |
+| `source_record_id` | `string` | Stable row identifier assigned during Electric Sheep Africa engineering. | `2d3c933d-1fa0-4689-b383-83c519dc2852:0` |
+| `country_iso3` | `dictionary<values=string, indices=int8, ordered=0>` | ISO3 country or area code. | `TCD` |
+| `country_name` | `dictionary<values=string, indices=int8, ordered=0>` | Country or area name. | `Chad` |
+| `country_name_2` | `string` | Source column from the original resource. | `#country` |
+| `admin1_name` | `string` | Source column from the original resource. | `#adm1+name` |
+| `latitude` | `double` | Source column from the original resource. | `` |
+| `longitude` | `double` | Source column from the original resource. | `` |
+| `aggregation` | `string` | Source column from the original resource. | `` |
+| `indicator` | `string` | Source column from the original resource. | `#indicator+name` |
+| `value` | `double` | Numeric observation value. | `` |
+| `source_period_start_year` | `int64` | Start year inferred from source metadata. | `` |
+| `source_period_end_year` | `int64` | End year inferred from source metadata. | `` |
+| `source_period_label` | `string` | Source column from the original resource. | `` |
+| `source_provider` | `dictionary<values=string, indices=int8, ordered=0>` | Publishing organization. | `ETH Zürich - Weather and Climate Risks` |
+| `source_dataset` | `dictionary<values=string, indices=int8, ordered=0>` | Source dataset or package title. | `LitPop: Humanitarian Response Plan (HRP) Countries Exposure Data for ...` |
+| `source_resource` | `dictionary<values=string, indices=int8, ordered=0>` | Source resource title, table name, or file name. | `haiti-admin1-litpop.csv` |
+| `source_package_id` | `dictionary<values=string, indices=int8, ordered=0>` | Source package identifier. | `3527869c-8fe9-4289-9d57-1811e789bf60` |
+| `source_resource_id` | `dictionary<values=string, indices=int8, ordered=0>` | Source resource identifier. | `2d3c933d-1fa0-4689-b383-83c519dc2852` |
+| `source_url` | `dictionary<values=string, indices=int8, ordered=0>` | Original source URL or download URL. | `https://data.humdata.org/dataset/3527869c-8fe9-4289-9d57-1811e789bf60...` |
+| `license_id` | `dictionary<values=string, indices=int8, ordered=0>` | Source license identifier. | `cc-by` |
+| `retrieved_at` | `dictionary<values=string, indices=int8, ordered=0>` | UTC source retrieval timestamp from the Electric Sheep Africa pipeline. | `2026-08-10T22:51:43Z` |
 
 ## Usage
 
@@ -96,29 +119,77 @@ df = ds["train"].to_pandas()
 print(df.head())
 ```
 
-### Filter to one country
+### Inspect Columns
 
 ```python
-sample_country = df[df["country_iso3"] == "TCD"]
+print(df.info())
+print(df.head())
 ```
 
-### Work with indicators
+### Filter By Geography
 
 ```python
-if "indicator_id" in df.columns:
-    print(df["indicator_id"].value_counts().head())
-    sample = df.sort_values([c for c in ["indicator_id", "year"] if c in df.columns])
+if "country_iso3" in df.columns:
+    sample = df[df["country_iso3"] == "TCD"]
 ```
 
+### Time-Series Pattern
+
+```python
+if "value" in df.columns and "source_period_start_year" in df.columns:
+    trend = df.sort_values("source_period_start_year")
+```
+
+### Pivot For Analysis
+
+```python
+if {"indicator_id", "year", "value"}.issubset(df.columns):
+    matrix = df.pivot_table(index="year", columns="indicator_id", values="value")
+    print(matrix.tail())
+```
+
+## Data Quality Notes
+
+- Canonical time field: `source_period_start_year`.
+- Missing values are preserved rather than silently imputed.
+- Column names are standardized for machine use; source meanings are preserved where known.
+- Always confirm source methodology, units, and collection definitions before policy, production, or redistribution-sensitive use.
+
+## Source And Provenance
+
+- **Source:** [ETH Zürich - Weather and Climate Risks](https://data.humdata.org/dataset/climada-litpop-dataset)
+- **Publisher:** ETH Zürich - Weather and Climate Risks
+- **Portal:** [https://data.humdata.org](https://data.humdata.org)
+- **Resource:** [haiti-admin1-litpop.csv](https://data.humdata.org/dataset/3527869c-8fe9-4289-9d57-1811e789bf60/resource/2d3c933d-1fa0-4689-b383-83c519dc2852/download/haiti-admin1-litpop.csv)
+- **License:** [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/)
+- **Retrieved/generated:** `2026-08-11T00:10:36Z`
+- **Hugging Face repo:** [electricsheepafrica/africa-chad-litpop-humanitarian-response-plan-hrp-countries-exposure-d-16639944](https://huggingface.co/datasets/electricsheepafrica/africa-chad-litpop-humanitarian-response-plan-hrp-countries-exposure-d-16639944)
+
+## Transformations Applied
+
+- Converted the source table to Parquet for efficient analytics and ML workflows.
+- Added or preserved source provenance columns where available.
+- Standardized README metadata, dataset loading configuration, schema documentation, and citation format.
+- Preserved source-reported values without analytical imputation.
+
+## Suggested Analyses
+
+- Profile the distribution of values
+- Compare categories or geographies
+- Join with complementary public datasets
+- Build time-series views and period-over-period comparisons
+- Check missingness before modeling
+- Use `country_iso3` as the safest geography join key when present
+
 ## Citation
 
 ```bibtex
 @misc{electric_sheep_africa_africa_chad_litpop_humanitarian_response_plan_hrp_countries_exposure_d_16639944_2026,
-  title        = {LitPop: Humanitarian Response Plan (HRP) Countries Exposure Data for Disaster Risk Assessment | Africa (Chad official open data)},
+  title        = {Litpop Humanitarian Response Plan Hrp Countries Exposure D | Africa (ETH Zürich - Weather and Climate Risks)},
   author       = {ETH Zürich - Weather and Climate Risks},
   year         = {2026},
   url          = {https://data.humdata.org/dataset/climada-litpop-dataset},
-  publisher    = {HuggingFace Datasets, repackaged by Electric Sheep Africa},
+  publisher    = {Hugging Face Datasets, engineered by Electric Sheep Africa},
   howpublished = {\url{https://huggingface.co/datasets/electricsheepafrica/africa-chad-litpop-humanitarian-response-plan-hrp-countries-exposure-d-16639944}}
 }
 ```
@@ -127,20 +198,14 @@ if "indicator_id" in df.columns:
 
 Released under [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/).
 
-Original data (c) ETH Zürich - Weather and Climate Risks. When using this dataset, please cite both the
-original source above and the Electric Sheep Africa repackaging.
-
-## About Electric Sheep
+Original data is published by ETH Zürich - Weather and Climate Risks. Electric Sheep Africa
+engineering standardizes the data for discovery, loading, and analysis on
+Hugging Face. Cite both the original source and this ML-ready dataset when used.
 
-Electric Sheep Africa is part of the Electric Sheep mission: a unified,
-ML-ready data layer for Africa on Hugging Face. We pull data from authoritative
-open sources, normalize the schemas, package as Parquet, and publish with
-consistent dataset cards so researchers and developers can use `load_dataset()`
-to start working in seconds.
+## About Electric Sheep Africa
 
-Browse the full collection: [huggingface.co/electricsheepafrica](https://huggingface.co/electricsheepafrica)
+Electric Sheep Africa publishes ML-ready African public datasets on Hugging Face.
 
 ---
 
-Provenance: ingested 2026-08-11 via the Electric Sheep pipeline. Source URL:
-https://data.humdata.org/dataset/3527869c-8fe9-4289-9d57-1811e789bf60/resource/2d3c933d-1fa0-4689-b383-83c519dc2852/download/haiti-admin1-litpop.csv
+Provenance: README standardized 2026-08-11 by the Electric Sheep Africa README system. Source URL: https://data.humdata.org/dataset/climada-litpop-dataset