Add README.md

README.md

@@ -1,32 +1,150 @@
 ---
+annotations_creators:
+- no-annotation
+language_creators:
+- found
+language:
+- en
+license: cc-by-4.0
+multilinguality:
+- monolingual
+size_categories:
+- n<1K
+source_datasets:
+- original
+task_categories:
+- tabular-classification
+task_ids: []
+tags:
+- africa
+- humanitarian
+- hdx
+- electric-sheep-africa
+- covid-19
+- disease
+- epidemics-outbreaks
+- health
+- arg
+- aus
+- aut
+- bhr
+- bel
+pretty_name: "Total COVID-19 Tests Performed by Country"
 dataset_info:
-  features:
-  - name: entity
-    dtype: string
-  - name: code
-    dtype: string
-  - name: year
-    dtype: int64
-  - name: total_covid_19_tests
-    dtype: int64
-  - name: esa_source
-    dtype: string
-  - name: esa_processed
-    dtype: string
   splits:
-  - name: train
-    num_bytes: 3626
-    num_examples: 61
-  - name: test
-    num_bytes: 921
-    num_examples: 16
-  download_size: 7340
-  dataset_size: 4547
-configs:
-- config_name: default
-  data_files:
-  - split: train
-    path: data/train-*
-  - split: test
-    path: data/test-*
+    - name: train
+      num_examples: 61
+    - name: test
+      num_examples: 15
 ---
+
+# Total COVID-19 Tests Performed by Country
+
+**Publisher:** HDX · **Source:** [HDX](https://data.humdata.org/dataset/total-covid-19-tests-performed-by-country) · **License:** `cc-by` · **Updated:** 2025-09-08
+
+---
+
+## Abstract
+
+'Our World in Data' is compiling COVID-19 testing data over time for many countries around the world. They are adding further data in the coming days as more details become available for other countries. In some cases figures refer to the number of tests, in other cases to the number of individuals who have been tested. Refer to documentation provided [here](https://ourworldindata.org/covid-testing).
+
+Each row in this dataset represents time-series observations. Data was last updated on HDX on 2025-09-08. Geographic scope: **ARG, AUS, AUT, BHR, BEL, BOL, CAN, CHL, and 55 others**.
+
+*Curated into ML-ready Parquet format by [Electric Sheep Africa](https://huggingface.co/electricsheepafrica).*
+
+---
+
+## Dataset Characteristics
+
+| | |
+|---|---|
+| **Domain** | Public health |
+| **Unit of observation** | Time-series observations |
+| **Rows (total)** | 77 |
+| **Columns** | 6 (2 numeric, 4 categorical, 0 datetime) |
+| **Train split** | 61 rows |
+| **Test split** | 15 rows |
+| **Geographic scope** | ARG, AUS, AUT, BHR, BEL, BOL, CAN, CHL, and 55 others |
+| **Publisher** | HDX |
+| **HDX last updated** | 2025-09-08 |
+
+---
+
+## Variables
+
+**Geographic** — `entity` (Armenia, Mexico, Philippines), `year` (range 34.0–59.0).
+
+**Outcome / Measurement** — `total_covid_19_tests` (range 222.0–320000.0).
+
+**Identifier / Metadata** — `code` (ARM, SVK, MEX), `esa_source` (HDX), `esa_processed` (2026-04-06).
+
+---
+
+## Quick Start
+
+```python
+from datasets import load_dataset
+
+ds    = load_dataset("electricsheepafrica/africa-total-covid-19-tests-performed-by-country")
+train = ds["train"].to_pandas()
+test  = ds["test"].to_pandas()
+
+print(train.shape)
+train.head()
+```
+
+---
+
+## Schema
+
+| Column | Type | Null % | Range / Sample Values |
+|---|---|---|---|
+| `entity` | object | 0.0% | Armenia, Mexico, Philippines |
+| `code` | object | 23.4% | ARM, SVK, MEX |
+| `year` | int64 | 0.0% | 34.0 – 59.0 (mean 56.5065) |
+| `total_covid_19_tests` | int64 | 0.0% | 222.0 – 320000.0 (mean 30387.961) |
+| `esa_source` | object | 0.0% | HDX |
+| `esa_processed` | object | 0.0% | 2026-04-06 |
+
+---
+
+## Numeric Summary
+
+| Column | Min | Max | Mean | Median |
+|---|---|---|---|---|
+| `year` | 34.0 | 59.0 | 56.5065 | 58.0 |
+| `total_covid_19_tests` | 222.0 | 320000.0 | 30387.961 | 8603.0 |
+
+---
+
+## 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 HDX and has not been independently validated by ESA.
+- Automated cleaning cannot correct for misreported values, definitional inconsistencies, or sampling bias in the original collection.
+- The following columns have >20% missing values and should be treated with caution in modelling: `code`.
+- This dataset spans 63 countries; geographic and methodological inconsistencies across national boundaries may affect cross-country comparability.
+- Refer to the [original HDX dataset page](https://data.humdata.org/dataset/total-covid-19-tests-performed-by-country) for the publisher's own methodology notes and caveats.
+
+---
+
+## Citation
+
+```bibtex
+@dataset{hdx_africa_total_covid_19_tests_performed_by_country,
+  title     = {Total COVID-19 Tests Performed by Country},
+  author    = {HDX},
+  year      = {2025},
+  url       = {https://data.humdata.org/dataset/total-covid-19-tests-performed-by-country},
+  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.*