Add README.md

README.md

@@ -1,26 +1,140 @@
 ---
+annotations_creators:
+- no-annotation
+language_creators:
+- found
+language:
+- en
+license: cc-by-4.0
+multilinguality:
+- monolingual
+size_categories:
+- 1K<n<10K
+source_datasets:
+- original
+task_categories:
+- tabular-classification
+task_ids: []
+tags:
+- africa
+- humanitarian
+- hdx
+- electric-sheep-africa
+- disease
+- epidemics-outbreaks
+- fatalities
+- health
+- hxl
+- west-africa
+- ben
+pretty_name: "Bénin: Coronavirus (Covid-19) Subnational"
 dataset_info:
-  features:
-  - name: id_date_iso_3_pays_id_pays_region_id_region_contaminés_décès_guéris_femme_homme_genre_non_spécifié_source
-    dtype: string
-  - name: esa_source
-    dtype: string
-  - name: esa_processed
-    dtype: string
   splits:
-  - name: train
-    num_bytes: 249459
-    num_examples: 2360
-  - name: test
-    num_bytes: 62517
-    num_examples: 591
-  download_size: 65070
-  dataset_size: 311976
-configs:
-- config_name: default
-  data_files:
-  - split: train
-    path: data/train-*
-  - split: test
-    path: data/test-*
+    - name: train
+      num_examples: 2360
+    - name: test
+      num_examples: 590
 ---
+
+# Bénin: Coronavirus (Covid-19) Subnational
+
+**Publisher:** HERA - Humanitarian Emergency Response Africa · **Source:** [HDX](https://data.humdata.org/dataset/benin-covid-19-subnational) · **License:** `cc-by` · **Updated:** 2025-04-10
+
+---
+
+## Abstract
+
+Subnational data about Covid19 in Bénin - Infections (new cases, gender), Deaths, Recoveries when available. Unfortunately the country does not give the details per region anymore, we keep the database updated at the national level while waiting for the disaggregated data.
+
+Each row in this dataset represents first-level administrative unit observations. Data was last updated on HDX on 2025-04-10. Geographic scope: **BEN**.
+
+*Curated into ML-ready Parquet format by [Electric Sheep Africa](https://huggingface.co/electricsheepafrica).*
+
+---
+
+## Dataset Characteristics
+
+| | |
+|---|---|
+| **Domain** | Public health |
+| **Unit of observation** | First-level administrative unit observations |
+| **Rows (total)** | 2,951 |
+| **Columns** | 3 (0 numeric, 3 categorical, 0 datetime) |
+| **Train split** | 2,360 rows |
+| **Test split** | 590 rows |
+| **Geographic scope** | BEN |
+| **Publisher** | HERA - Humanitarian Emergency Response Africa |
+| **HDX last updated** | 2025-04-10 |
+
+---
+
+## Variables
+
+**Geographic** — `id_date_iso_3_pays_id_pays_region_id_region_contaminés_décès_guéris_femme_homme_genre_non_spécifié_source` (1;16/03/2020;BEN;Bénin;10;Alibori;96;0;0;0;0;0;0;VOA AFRIQUE, 1972;14/08/2020;BEN;Bénin;10;Ouémé;104;0;0;0;0;0;0;Gouvernement du Bénin, 1963;13/08/2020;BEN;Bénin;10;Non spécifié;108;62;1;9;null;null;62;Gouvernement du Bénin).
+
+**Identifier / Metadata** — `esa_source` (HDX), `esa_processed` (2026-04-05).
+
+---
+
+## Quick Start
+
+```python
+from datasets import load_dataset
+
+ds    = load_dataset("electricsheepafrica/africa-benin-covid-19-subnational")
+train = ds["train"].to_pandas()
+test  = ds["test"].to_pandas()
+
+print(train.shape)
+train.head()
+```
+
+---
+
+## Schema
+
+| Column | Type | Null % | Range / Sample Values |
+|---|---|---|---|
+| `id_date_iso_3_pays_id_pays_region_id_region_contaminés_décès_guéris_femme_homme_genre_non_spécifié_source` | object | 0.0% | 1;16/03/2020;BEN;Bénin;10;Alibori;96;0;0;0;0;0;0;VOA AFRIQUE, 1972;14/08/2020;BEN;Bénin;10;Ouémé;104;0;0;0;0;0;0;Gouvernement du Bénin, 1963;13/08/2020;BEN;Bénin;10;Non spécifié;108;62;1;9;null;null;62;Gouvernement du Bénin |
+| `esa_source` | object | 0.0% | HDX |
+| `esa_processed` | object | 0.0% | 2026-04-05 |
+
+---
+
+## Numeric Summary
+
+| Column | Min | Max | Mean | Median |
+|---|---|---|---|---|
+_No numeric columns._
+
+---
+
+## Curation
+
+Raw data was downloaded from HDX via the CKAN API and converted to Parquet. Column names were lowercased and standardised to snake_case. Common missing-value markers (`N/A`, `null`, `none`, `-`, `unknown`, `no data`, `#N/A`) were unified to `NaN`. The dataset was split 80/20 into train and test partitions using a fixed random seed (42) and saved as Snappy-compressed Parquet.
+
+---
+
+## Limitations
+
+- Data originates from HERA - Humanitarian Emergency Response Africa and has not been independently validated by ESA.
+- Automated cleaning cannot correct for misreported values, definitional inconsistencies, or sampling bias in the original collection.
+- Refer to the [original HDX dataset page](https://data.humdata.org/dataset/benin-covid-19-subnational) for the publisher's own methodology notes and caveats.
+
+---
+
+## Citation
+
+```bibtex
+@dataset{hdx_africa_benin_covid_19_subnational,
+  title     = {Bénin: Coronavirus (Covid-19) Subnational},
+  author    = {HERA - Humanitarian Emergency Response Africa},
+  year      = {2025},
+  url       = {https://data.humdata.org/dataset/benin-covid-19-subnational},
+  note      = {Repackaged for machine learning by Electric Sheep Africa (https://huggingface.co/electricsheepafrica)}
+}
+```
+
+---
+
+*[Electric Sheep Africa](https://huggingface.co/electricsheepafrica) — Africa's ML dataset infrastructure. Lagos, Nigeria.*