Add README.md

README.md

@@ -1,26 +1,145 @@
 ---
+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
+- covid-19
+- disease
+- epidemics-outbreaks
+- health
+- hxl
+- vaccination-immunization
+- west-africa
+- bfa
+pretty_name: "Burkina Faso: Coronavirus (Covid-19) Subnational Vaccination data"
 dataset_info:
-  features:
-  - name: id_date_iso_3_pays_id_pays_region_id_region_nouveaux_individus_vaccines_1_dose_total_individus_vaccines_1_dose_nouveaux_agents_sante_vaccines_1_dose_total_agents_sante_vaccines_1_dose_nouveaux_individus_vaccines_2_doses_total_individus_vaccines_2_doses_nouveaux_agents_sante_vaccines_2_doses_total_agents_sante_vaccines_2_doses_source
-    dtype: string
-  - name: esa_source
-    dtype: string
-  - name: esa_processed
-    dtype: string
   splits:
-  - name: train
-    num_bytes: 118838
-    num_examples: 862
-  - name: test
-    num_bytes: 29791
-    num_examples: 216
-  download_size: 34345
-  dataset_size: 148629
-configs:
-- config_name: default
-  data_files:
-  - split: train
-    path: data/train-*
-  - split: test
-    path: data/test-*
+    - name: train
+      num_examples: 862
+    - name: test
+      num_examples: 215
 ---
+
+# Burkina Faso: Coronavirus (Covid-19) Subnational Vaccination data
+
+**Publisher:** HERA - Humanitarian Emergency Response Africa · **Source:** [HDX](https://data.humdata.org/dataset/burkina-faso-coronavirus-covid-19-subnational-vaccination-data) · **License:** `cc-by` · **Updated:** 2025-05-05
+
+---
+
+## Abstract
+
+Subnational Covid19 vaccination data in Burkina Faso per region from the beginning of the vaccination campaign. 
+Vaccine type : AstraZeneca ; Johnson & Johnson
+Details : first & second dose
+Covax initiative
+Data : new vaccinated, cumulative vaccinated, new health workers vaccinated, cumulative health workers vaccinated
+
+Each row in this dataset represents first-level administrative unit observations. Data was last updated on HDX on 2025-05-05. Geographic scope: **BFA**.
+
+*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)** | 1,078 |
+| **Columns** | 3 (0 numeric, 3 categorical, 0 datetime) |
+| **Train split** | 862 rows |
+| **Test split** | 215 rows |
+| **Geographic scope** | BFA |
+| **Publisher** | HERA - Humanitarian Emergency Response Africa |
+| **HDX last updated** | 2025-05-05 |
+
+---
+
+## Variables
+
+**Geographic** — `id_date_iso_3_pays_id_pays_region_id_region_nouveaux_individus_vaccines_1_dose_total_individus_vaccines_1_dose_nouveaux_agents_sante_vaccines_1_dose_total_agents_sante_vaccines_1_dose_nouveaux_individus_vaccines_2_doses_total_individus_vaccines_2_doses_nouveaux_agents_sante_vaccines_2_doses_total_agents_sante_vaccines_2_doses_source` (1;03/06/2021;BFA;Burkina Faso;16;Boucle du Mouhoun;208;0;0;0;0;0;0;0;0;Ministère de la Santé - Burkina Faso;;, 725;24/07/2021;BFA;Burkina Faso;16;Plateau-Central;218;0;773;0;252;0;0;0;0;Ministère de la Santé - Burkina Faso;;, 711;23/07/2021;BFA;Burkina Faso;16;Plateau-Central;218;0;773;0;252;0;0;0;0;Ministère de la Santé - Burkina Faso;;).
+
+**Identifier / Metadata** — `esa_source` (HDX), `esa_processed` (2026-04-04).
+
+---
+
+## Quick Start
+
+```python
+from datasets import load_dataset
+
+ds    = load_dataset("electricsheepafrica/africa-burkina-faso-coronavirus-covid-19-subnational-vaccination-data")
+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_nouveaux_individus_vaccines_1_dose_total_individus_vaccines_1_dose_nouveaux_agents_sante_vaccines_1_dose_total_agents_sante_vaccines_1_dose_nouveaux_individus_vaccines_2_doses_total_individus_vaccines_2_doses_nouveaux_agents_sante_vaccines_2_doses_total_agents_sante_vaccines_2_doses_source` | object | 0.0% | 1;03/06/2021;BFA;Burkina Faso;16;Boucle du Mouhoun;208;0;0;0;0;0;0;0;0;Ministère de la Santé - Burkina Faso;;, 725;24/07/2021;BFA;Burkina Faso;16;Plateau-Central;218;0;773;0;252;0;0;0;0;Ministère de la Santé - Burkina Faso;;, 711;23/07/2021;BFA;Burkina Faso;16;Plateau-Central;218;0;773;0;252;0;0;0;0;Ministère de la Santé - Burkina Faso;; |
+| `esa_source` | object | 0.0% | HDX |
+| `esa_processed` | object | 0.0% | 2026-04-04 |
+
+---
+
+## 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/burkina-faso-coronavirus-covid-19-subnational-vaccination-data) for the publisher's own methodology notes and caveats.
+
+---
+
+## Citation
+
+```bibtex
+@dataset{hdx_africa_burkina_faso_coronavirus_covid_19_subnational_vaccination_data,
+  title     = {Burkina Faso: Coronavirus (Covid-19) Subnational Vaccination data},
+  author    = {HERA - Humanitarian Emergency Response Africa},
+  year      = {2025},
+  url       = {https://data.humdata.org/dataset/burkina-faso-coronavirus-covid-19-subnational-vaccination-data},
+  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.*