Add README.md

README.md

@@ -1,102 +1,197 @@
 ---
+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
+- tabular-regression
+task_ids: []
+tags:
+- africa
+- humanitarian
+- hdx
+- electric-sheep-africa
+- funding
+- ken
+pretty_name: "Kenya - IFRC Appeals"
 dataset_info:
-  features:
-  - name: aid
-    dtype: int64
-  - name: name
-    dtype: string
-  - name: dtype_id
-    dtype: int64
-  - name: dtype_name
-    dtype: string
-  - name: dtype_translation_module_original_language
-    dtype: string
-  - name: atype
-    dtype: int64
-  - name: atype_display
-    dtype: string
-  - name: status
-    dtype: int64
-  - name: status_display
-    dtype: string
-  - name: code
-    dtype: string
-  - name: sector
-    dtype: string
-  - name: amount_requested
-    dtype: float64
-  - name: amount_funded
-    dtype: float64
-  - name: start_date
-    dtype: timestamp[ns, tz=UTC]
-  - name: end_date
-    dtype: timestamp[ns, tz=UTC]
-  - name: real_data_update
-    dtype: timestamp[ns, tz=UTC]
-  - name: created_at
-    dtype: timestamp[ns, tz=UTC]
-  - name: modified_at
-    dtype: timestamp[ns, tz=UTC]
-  - name: event
-    dtype: float64
-  - name: needs_confirmation
-    dtype: bool
-  - name: country_iso
-    dtype: string
-  - name: country_iso3
-    dtype: string
-  - name: country_id
-    dtype: int64
-  - name: country_record_type
-    dtype: int64
-  - name: country_record_type_display
-    dtype: string
-  - name: country_region
-    dtype: int64
-  - name: country_independent
-    dtype: bool
-  - name: country_is_deprecated
-    dtype: bool
-  - name: country_fdrs
-    dtype: string
-  - name: country_name
-    dtype: string
-  - name: country_society_name
-    dtype: string
-  - name: country_translation_module_original_language
-    dtype: string
-  - name: region_name
-    dtype: int64
-  - name: region_id
-    dtype: int64
-  - name: region_region_name
-    dtype: string
-  - name: region_label
-    dtype: string
-  - name: region_translation_module_original_language
-    dtype: string
-  - name: id
-    dtype: int64
-  - name: initial_num_beneficiaries
-    dtype: int64
-  - name: esa_source
-    dtype: string
-  - name: esa_processed
-    dtype: string
   splits:
-  - name: train
-    num_bytes: 34987
-    num_examples: 83
-  - name: test
-    num_bytes: 8994
-    num_examples: 21
-  download_size: 47260
-  dataset_size: 43981
-configs:
-- config_name: default
-  data_files:
-  - split: train
-    path: data/train-*
-  - split: test
-    path: data/test-*
+    - name: train
+      num_examples: 83
+    - name: test
+      num_examples: 20
 ---
+
+# Kenya - IFRC Appeals
+
+**Publisher:** International Federation of Red Cross and Red Crescent Societies (IFRC) · **Source:** [HDX](https://data.humdata.org/dataset/ifrc-appeals-data-for-kenya) · **License:** `cc-by-igo` · **Updated:** 2026-04-09
+
+---
+
+## Abstract
+
+The International Federation of Red Cross and Red Crescent Societies (IFRC) is the world’s largest humanitarian network. Our secretariat supports local Red Cross and Red Crescent action in more than 192 countries, bringing together almost 15 million volunteers for the good of humanity.  
+  
+We launch Emergency Appeals for big and complex disasters affecting lots of people who will need long-term support to recover. We also support Red Cross and Red Crescent Societies to respond to lots of small and medium-sized disasters worldwide—through our Disaster Response Emergency Fund (DREF) and in other ways.  
+  
+There is also a [global dataset](https://data.humdata.org/dataset/global-ifrc-appeals-data).
+
+Each row in this dataset represents first-level administrative unit observations. Data was last updated on HDX on 2026-04-09. Geographic scope: **KEN**.
+
+*Curated into ML-ready Parquet format by [Electric Sheep Africa](https://huggingface.co/electricsheepafrica).*
+
+---
+
+## Dataset Characteristics
+
+| | |
+|---|---|
+| **Domain** | Humanitarian and development data |
+| **Unit of observation** | First-level administrative unit observations |
+| **Rows (total)** | 104 |
+| **Columns** | 41 (14 numeric, 19 categorical, 0 datetime) |
+| **Train split** | 83 rows |
+| **Test split** | 20 rows |
+| **Geographic scope** | KEN |
+| **Publisher** | International Federation of Red Cross and Red Crescent Societies (IFRC) |
+| **HDX last updated** | 2026-04-09 |
+
+---
+
+## Variables
+
+**Geographic** — `dtype_id` (range 1.0–27.0), `dtype_name` (Flood, Epidemic, Other), `dtype_translation_module_original_language` (en), `atype` (range 0.0–1.0), `atype_display` (DREF, Emergency Appeal) and 18 others.
+
+**Temporal** — `start_date`, `end_date`, `real_data_update`.
+
+**Outcome / Measurement** — `amount_requested` (range 0.0–232500000.0), `amount_funded` (range 0.0–26892490.34).
+
+**Identifier / Metadata** — `aid` (range 49.0–19862.0), `name` (Kenya - Floods, Kenya - Drought, Kenya), `code` (MDRKE071, MDRKE070, MDR64002), `id` (range 8.0–4410.0), `esa_source` and 1 others.
+
+**Other** — `status` (range 0.0–1.0), `sector` (Africa Regional Office and Country cluster for Kenya and Somalia, Country cluster for Ethiopia and Djibouti, Country cluster for Democratic Republic of Congo, Republic of Congo, Burundi and Rwanda), `created_at`, `modified_at`, `event` (range 8.0–7673.0) and 2 others.
+
+---
+
+## Quick Start
+
+```python
+from datasets import load_dataset
+
+ds    = load_dataset("electricsheepafrica/africa-ifrc-appeals-data-for-kenya")
+train = ds["train"].to_pandas()
+test  = ds["test"].to_pandas()
+
+print(train.shape)
+train.head()
+```
+
+---
+
+## Schema
+
+| Column | Type | Null % | Range / Sample Values |
+|---|---|---|---|
+| `aid` | int64 | 0.0% | 49.0 – 19862.0 (mean 9152.6442) |
+| `name` | object | 0.0% | Kenya - Floods, Kenya - Drought, Kenya |
+| `dtype_id` | int64 | 0.0% | 1.0 – 27.0 (mean 10.0481) |
+| `dtype_name` | object | 0.0% | Flood, Epidemic, Other |
+| `dtype_translation_module_original_language` | object | 0.0% | en |
+| `atype` | int64 | 0.0% | 0.0 – 1.0 (mean 0.4231) |
+| `atype_display` | object | 0.0% | DREF, Emergency Appeal |
+| `status` | int64 | 0.0% | 0.0 – 1.0 (mean 0.8558) |
+| `status_display` | object | 0.0% | Closed, Active |
+| `code` | object | 0.0% | MDRKE071, MDRKE070, MDR64002 |
+| `sector` | object | 0.0% | Africa Regional Office and Country cluster for Kenya and Somalia, Country cluster for Ethiopia and Djibouti, Country cluster for Democratic Republic of Congo, Republic of Congo, Burundi and Rwanda |
+| `amount_requested` | float64 | 0.0% | 0.0 – 232500000.0 (mean 6614192.7981) |
+| `amount_funded` | float64 | 0.0% | 0.0 – 26892490.34 (mean 1765817.0608) |
+| `start_date` | datetime64[ns, UTC] | 0.0% |  |
+| `end_date` | datetime64[ns, UTC] | 0.0% |  |
+| `real_data_update` | datetime64[ns, UTC] | 0.0% |  |
+| `created_at` | datetime64[ns, UTC] | 0.0% |  |
+| `modified_at` | datetime64[ns, UTC] | 0.0% |  |
+| `event` | float64 | 1.9% | 8.0 – 7673.0 (mean 2410.9902) |
+| `needs_confirmation` | bool | 0.0% |  |
+| `country_iso` | object | 0.0% | KE |
+| `country_iso3` | object | 0.0% | KEN |
+| `country_id` | int64 | 0.0% | 93.0 – 93.0 (mean 93.0) |
+| `country_record_type` | int64 | 0.0% | 1.0 – 1.0 (mean 1.0) |
+| `country_record_type_display` | object | 0.0% | Country |
+| `country_region` | int64 | 0.0% | 0.0 – 0.0 (mean 0.0) |
+| `country_independent` | bool | 0.0% |  |
+| `country_is_deprecated` | bool | 0.0% |  |
+| `country_fdrs` | object | 0.0% |  |
+| `country_name` | object | 0.0% |  |
+| `country_society_name` | object | 0.0% |  |
+| `country_translation_module_original_language` | object | 0.0% |  |
+| `region_name` | int64 | 0.0% | 0.0 – 0.0 (mean 0.0) |
+| `region_id` | int64 | 0.0% | 0.0 – 0.0 (mean 0.0) |
+| `region_region_name` | object | 0.0% |  |
+| `region_label` | object | 0.0% |  |
+| `region_translation_module_original_language` | object | 0.0% |  |
+| `id` | int64 | 0.0% | 8.0 – 4410.0 (mean 2329.5673) |
+| `initial_num_beneficiaries` | int64 | 0.0% | 0.0 – 32000000.0 (mean 1041183.5865) |
+| `esa_source` | object | 0.0% |  |
+| `esa_processed` | object | 0.0% |  |
+
+---
+
+## Numeric Summary
+
+| Column | Min | Max | Mean | Median |
+|---|---|---|---|---|
+| `aid` | 49.0 | 19862.0 | 9152.6442 | 8228.0 |
+| `dtype_id` | 1.0 | 27.0 | 10.0481 | 12.0 |
+| `atype` | 0.0 | 1.0 | 0.4231 | 0.0 |
+| `status` | 0.0 | 1.0 | 0.8558 | 1.0 |
+| `amount_requested` | 0.0 | 232500000.0 | 6614192.7981 | 420574.5 |
+| `amount_funded` | 0.0 | 26892490.34 | 1765817.0608 | 322306.415 |
+| `event` | 8.0 | 7673.0 | 2410.9902 | 1341.5 |
+| `country_id` | 93.0 | 93.0 | 93.0 | 93.0 |
+| `country_record_type` | 1.0 | 1.0 | 1.0 | 1.0 |
+| `country_region` | 0.0 | 0.0 | 0.0 | 0.0 |
+| `region_name` | 0.0 | 0.0 | 0.0 | 0.0 |
+| `region_id` | 0.0 | 0.0 | 0.0 | 0.0 |
+| `id` | 8.0 | 4410.0 | 2329.5673 | 2137.0 |
+| `initial_num_beneficiaries` | 0.0 | 32000000.0 | 1041183.5865 | 65000.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`. 2 column(s) with >80% missing values were removed: `dtype_summary`, `country_average_household_size`. 5 column(s) were cast from string to numeric or datetime based on parse-success rate (>85% threshold). 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 International Federation of Red Cross and Red Crescent Societies (IFRC) 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/ifrc-appeals-data-for-kenya) for the publisher's own methodology notes and caveats.
+
+---
+
+## Citation
+
+```bibtex
+@dataset{hdx_africa_ifrc_appeals_data_for_kenya,
+  title     = {Kenya - IFRC Appeals},
+  author    = {International Federation of Red Cross and Red Crescent Societies (IFRC)},
+  year      = {2026},
+  url       = {https://data.humdata.org/dataset/ifrc-appeals-data-for-kenya},
+  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.*