Standardize Electric Sheep Africa dataset card

README.md

@@ -5,89 +5,117 @@ language:
 task_categories:
 - tabular-classification
 - tabular-regression
-multilinguality: monolingual
+multilinguality: multilingual
 size_categories:
 - n<1K
 tags:
-- tabular
-- xlsx
-- africa
-- nigeria
-- official-statistics
-- open-data
-- economics
-pretty_name: "National Household Kerosene Price Watch | Africa (Nigeria official open data)"
+- "tabular"
+- "africa"
+- "open-data"
+- "official-statistics"
+- "nigeria"
+- "national-bureau-of-statistics-nigeria"
+- "economics"
+- "national-economy"
+- "nhk-may-2025-tables"
+- "household-kerosene-may-2025-xlsx"
+- "0"
+- "document"
+- "nhk"
+- "table-tbl"
+- "other-materials"
+configs:
+- config_name: default
+  data_files:
+  - split: train
+    path: data/train-00000-of-00001.parquet
+pretty_name: "National Household Kerosene Price Watch | Africa (National Bureau of Statistics, Nigeria)"
 ---
 
-# National Household Kerosene Price Watch | Africa (Nigeria official open data)
+# National Household Kerosene Price Watch | Africa (National Bureau of Statistics, Nigeria)
 
-51 rows - 1 Africa country - 2025 - Repackaged by [Electric Sheep Africa](https://huggingface.co/electricsheepafrica)
+**51 rows** - **1 Africa country/area** - **2025** - **source table** - *Engineered by [Electric Sheep Africa](https://huggingface.co/electricsheepafrica)*
 
 ![rows](https://img.shields.io/badge/rows-51-blue)
 ![countries](https://img.shields.io/badge/countries-1-green)
-![years](https://img.shields.io/badge/years-2025-orange)
+![period](https://img.shields.io/badge/period-2025-orange)
 ![indicators](https://img.shields.io/badge/indicators-0-purple)
 ![license](https://img.shields.io/badge/license-other-lightgrey)
 
 ## TL;DR
 
-This dataset packages one official `XLSX` resource from **Nigeria** 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 **51 rows** from **National Bureau of Statistics, Nigeria**, covering **National Household Kerosene Price Watch**. 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:** [National Household Kerosene Price Watch](https://microdata.nigerianstat.gov.ng/index.php/catalog/159/related-materials)
-- **Publisher:** National Bureau of Statistics, Nigeria
-- **Resource:** [NHK May 2025 Tables](https://microdata.nigerianstat.gov.ng/index.php/catalog/159/download/1250)
-- **Format:** `XLSX`
-- **License:** [Other open license]()
-- **Packaging mode:** `tabular_resource`
+Economic datasets help analysts examine production, prices, public finance, trade flows, market conditions, and macroeconomic change.
+
+Source-provided context: Table [tbl]
+
+## 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:** `year`.
+- **Time coverage basis:** year.
+- **Recommended join keys:** `country_iso3` where available plus source-specific keys.
+
+## Coverage
+
+| Dimension | Value |
+|---|---:|
+| Rows | 51 |
+| Countries/areas | 1 |
+| First period | 2025 |
+| Last period | 2025 |
+| Indicators | 0 |
+| Columns | 28 |
+| Source format | XLSX |
 
-## Geographic coverage
+## Geographic Coverage
 
-1 Africa country:
+Top areas shown below, sorted by row count when available:
 
-| Country | Rows | First year | Last year | Name |
-|---------|-----:|-----------:|----------:|------|
+| Area | Rows | First year | Last year | Name |
+|------|-----:|-----------:|----------:|------|
 | `NGA` | 51 | 2025 | 2025 | `Nigeria` |
 
-## 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. | `nbs-nada-159-1250:nhk-may-2025:0` |
-| `country_iso3` | `string` | ISO3 country code. | `NGA` |
-| `country_name` | `string` | Country name. | `Nigeria` |
-| `source_sheet` | `string` | Workbook sheet name, when the source is a spreadsheet. | `NHK MAY 2025` |
-| `year` | `Int64` | Observation year. | `2025` |
-| `north_central` | `string` | Source column. | `Abuja` |
-| `d_1534_1152572142855` | `float64` | Source column. | `1620.4900205` |
-| `d_2156_168782124372` | `float64` | Source column. | `2542.0532` |
-| `d_2071_0305855759425` | `float64` | Source column. | `2355.10618` |
-| `d_3_948586829299449` | `float64` | Source column. | `-7.354174176999919` |
-| `d_34_99836963596931` | `float64` | Source column. | `45.33296411620819` |
-| `north_central_2` | `string` | Source column. | `Abuja` |
-| `d_4659_733298928571` | `float64` | Source column. | `4582.458916` |
-| `d_8296_10369992606` | `float64` | Source column. | `7368.2128` |
-| `d_8141_265199446628` | `float64` | Source column. | `8420.42472` |
-| `d_1_8664002534203092` | `float64` | Source column. | `14.280422519827326` |
-| `d_74_71526109270198` | `float64` | Source column. | `83.75341436449011` |
-| `source_period_start_year` | `Int64` | First year inferred from source resource metadata. | `2025` |
-| `source_period_end_year` | `Int64` | Last year inferred from source resource metadata. | `2025` |
-| `source_period_label` | `string` | Human-readable period inferred from source resource metadata. | `2025` |
+| `source_record_id` | `string` | Stable row identifier assigned during Electric Sheep Africa engineering. | `nbs-nada-159-1250:nhk-may-2025:0` |
+| `country_iso3` | `string` | ISO3 country or area code. | `NGA` |
+| `country_name` | `string` | Country or area name. | `Nigeria` |
+| `source_sheet` | `string` | Source column from the original resource. | `NHK MAY 2025` |
+| `year` | `int64` | Observation year. | `2025` |
+| `north_central` | `string` | Source column from the original resource. | `Abuja` |
+| `d_1534_1152572142855` | `double` | Source column from the original resource. | `1620.4900205` |
+| `d_2156_168782124372` | `double` | Source column from the original resource. | `2542.0532` |
+| `d_2071_0305855759425` | `double` | Source column from the original resource. | `2355.10618` |
+| `d_3_948586829299449` | `double` | Source column from the original resource. | `-7.354174176999919` |
+| `d_34_99836963596931` | `double` | Source column from the original resource. | `45.33296411620819` |
+| `north_central_2` | `string` | Source column from the original resource. | `Abuja` |
+| `d_4659_733298928571` | `double` | Source column from the original resource. | `4582.458916` |
+| `d_8296_10369992606` | `double` | Source column from the original resource. | `7368.2128` |
+| `d_8141_265199446628` | `double` | Source column from the original resource. | `8420.42472` |
+| `d_1_8664002534203092` | `double` | Source column from the original resource. | `14.280422519827326` |
+| `d_74_71526109270198` | `double` | Source column from the original resource. | `83.75341436449011` |
+| `source_period_start_year` | `int64` | Start year inferred from source metadata. | `2025` |
+| `source_period_end_year` | `int64` | End year inferred from source metadata. | `2025` |
+| `source_period_label` | `string` | Source column from the original resource. | `2025` |
 | `source_provider` | `string` | Publishing organization. | `National Bureau of Statistics, Nigeria` |
-| `source_dataset` | `string` | Source package title. | `National Household Kerosene Price Watch` |
-| `source_resource` | `string` | Source resource title. | `NHK May 2025 Tables` |
-| `source_package_id` | `string` | CKAN package UUID. | `NGA-NBS-NHK` |
-| `source_resource_id` | `string` | CKAN resource UUID. | `nbs-nada-159-1250` |
-| `source_url` | `string` | Original source resource URL. | `https://microdata.nigerianstat.gov.ng/index.php/catalog/159/download/125` |
+| `source_dataset` | `string` | Source dataset or package title. | `National Household Kerosene Price Watch` |
+| `source_resource` | `string` | Source resource title, table name, or file name. | `NHK May 2025 Tables` |
+| `source_package_id` | `string` | Source package identifier. | `NGA-NBS-NHK` |
+| `source_resource_id` | `string` | Source resource identifier. | `nbs-nada-159-1250` |
+| `source_url` | `string` | Original source URL or download URL. | `https://microdata.nigerianstat.gov.ng/index.php/catalog/159/download/...` |
 | `license_id` | `string` | Source license identifier. | `other-open` |
-| `retrieved_at` | `string` | UTC retrieval timestamp. | `2026-07-19T04:13:01Z` |
+| `retrieved_at` | `string` | UTC source retrieval timestamp from the Electric Sheep Africa pipeline. | `2026-07-19T04:13:01Z` |
 
 ## Usage
 
@@ -99,51 +127,93 @@ df = ds["train"].to_pandas()
 print(df.head())
 ```
 
-### Filter to one country
+### Inspect Columns
 
 ```python
-sample_country = df[df["country_iso3"] == "NGA"]
+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"] == "NGA"]
 ```
 
+### Time-Series Pattern
+
+```python
+if "value" in df.columns and "year" in df.columns:
+    trend = df.sort_values("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: `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:** [National Bureau of Statistics, Nigeria](https://microdata.nigerianstat.gov.ng/index.php/catalog/159/related-materials)
+- **Publisher:** National Bureau of Statistics, Nigeria
+- **Portal:** [https://microdata.nigerianstat.gov.ng](https://microdata.nigerianstat.gov.ng)
+- **Resource:** [NHK May 2025 Tables](https://microdata.nigerianstat.gov.ng/index.php/catalog/159/download/1250)
+- **License:** other-open
+- **Retrieved/generated:** `2026-07-19T04:19:27Z`
+- **Hugging Face repo:** [electricsheepafrica/africa-nigeria-national-household-kerosene-price-watch-c36ef609](https://huggingface.co/datasets/electricsheepafrica/africa-nigeria-national-household-kerosene-price-watch-c36ef609)
+
+## 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
+
+- Build time-series dashboards
+- Compare economic indicators
+- Join with population or sector data
+- 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_nigeria_national_household_kerosene_price_watch_c36ef609_2025,
-  title        = {National Household Kerosene Price Watch | Africa (Nigeria official open data)},
+  title        = {National Household Kerosene Price Watch | Africa (National Bureau of Statistics, Nigeria)},
   author       = {National Bureau of Statistics, Nigeria},
   year         = {2025},
   url          = {https://microdata.nigerianstat.gov.ng/index.php/catalog/159/related-materials},
-  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-nigeria-national-household-kerosene-price-watch-c36ef609}}
 }
 ```
 
 ## License
 
-Released under [Other open license]().
-
-Original data (c) National Bureau of Statistics, Nigeria. When using this dataset, please cite both the
-original source above and the Electric Sheep Africa repackaging.
+Released under other-open.
 
-## About Electric Sheep
+Original data is published by National Bureau of Statistics, Nigeria. 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-07-19 via the Electric Sheep pipeline. Source URL:
-https://microdata.nigerianstat.gov.ng/index.php/catalog/159/download/1250
+Provenance: README standardized 2026-08-12 by the Electric Sheep Africa README system. Source URL: https://microdata.nigerianstat.gov.ng/index.php/catalog/159/related-materials