Standardize Electric Sheep Africa dataset card

README.md

@@ -5,83 +5,107 @@ language:
 task_categories:
 - tabular-classification
 - tabular-regression
-multilinguality: monolingual
+multilinguality: multilingual
 size_categories:
 - n<1K
 tags:
-- tabular
-- csv
-- africa
-- mozambique
-- official-statistics
-- open-data
+- "tabular"
+- "africa"
+- "open-data"
+- "official-statistics"
+- "mozambique"
+- "instituto-nacional-de-saude"
+- "transport"
+- "demograficos"
+- "base-carga-viral"
+- "base-carga-viral-csv"
+- "2022"
+- "survey"
+- "nao-e-aplicavel"
+- "document"
+- "questionnaire-doc"
 configs:
 - config_name: default
   data_files:
   - split: train
     path: data/train-00000-of-00001.parquet
-pretty_name: "Inquérito Biológico e Comportamental em Reclusos e Agentes em 22 Estabelecimentos Penitenciários em Moçambique, 2023-Segunda Ronda | Africa (Mozambique official open data)"
+pretty_name: "Inquerito Biologico E Comportamental Em Reclusos E Agentes | Africa (Instituto Nacional de Saúde)"
 ---
 
-# Inquérito Biológico e Comportamental em Reclusos e Agentes em 22 Estabelecimentos Penitenciários em Moçambique, 2023-Segunda Ronda | Africa (Mozambique official open data)
+# Inquerito Biologico E Comportamental Em Reclusos E Agentes | Africa (Instituto Nacional de Saúde)
 
-273 rows - 1 Africa country - 2023-2024 - Repackaged by [Electric Sheep Africa](https://huggingface.co/electricsheepafrica)
+**273 rows** - **1 Africa country/area** - **2023-2024** - **source table** - *Engineered by [Electric Sheep Africa](https://huggingface.co/electricsheepafrica)*
 
 ![rows](https://img.shields.io/badge/rows-273-blue)
 ![countries](https://img.shields.io/badge/countries-1-green)
-![years](https://img.shields.io/badge/years-2023-2024-orange)
+![period](https://img.shields.io/badge/period-2023--2024-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 `CSV` resource from **Mozambique** 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 **273 rows** from **Instituto Nacional de Saúde**, covering **Inquerito Biologico E Comportamental Em Reclusos E Agentes**. 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:** [Inquérito Biológico e Comportamental em Reclusos e Agentes em 22 Estabelecimentos Penitenciários em Moçambique, 2023-Segunda Ronda](https://mozdata.ine.gov.mz/index.php/catalog/128/related-materials)
-- **Publisher:** Instituto Nacional de Saúde
-- **Resource:** [BASE CARGA_VIRAL](https://mozdata.ine.gov.mz/index.php/catalog/128/download/1160)
-- **Format:** `CSV`
-- **License:** [Other open license]()
-- **Packaging mode:** `tabular_resource`
+Transport datasets help analysts examine mobility, infrastructure, passenger movement, logistics, and access to services.
+
+Source-provided context: Document, Questionnaire [doc/qst]
+
+## 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:** `not detected`.
+- **Time coverage basis:** source metadata.
+- **Recommended join keys:** `country_iso3` where available plus source-specific keys.
+
+## Coverage
+
+| Dimension | Value |
+|---|---:|
+| Rows | 273 |
+| Countries/areas | 1 |
+| First period | 2023 |
+| Last period | 2024 |
+| Indicators | 0 |
+| Columns | 18 |
+| Source format | CSV |
 
-## 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 |
+|------|-----:|-----------:|----------:|------|
 | `MOZ` | 273 | 2023 | 2024 | `Mozambique` |
 
-## 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. | `moz-ine-nada-128-1160:0` |
-| `country_iso3` | `category` | ISO3 country code. | `MOZ` |
-| `country_name` | `category` | Country name. | `Mozambique` |
-| `n_codparticipante` | `string` | Source column. | `PRI0102M008` |
-| `cons_hiv` | `string` | Source column. | `Sim` |
-| `cv_resul` | `string` | Source column. | `detectavel` |
-| `cv_absoluto` | `float64` | Source column. | `400.0` |
-| `source_period_start_year` | `Int64` | First year inferred from source resource metadata. | `2023` |
-| `source_period_end_year` | `Int64` | Last year inferred from source resource metadata. | `2024` |
-| `source_period_label` | `category` | Human-readable period inferred from source resource metadata. | `2023-2024` |
-| `source_provider` | `category` | Publishing organization. | `Instituto Nacional de Saúde` |
-| `source_dataset` | `category` | Source package title. | `Inquérito Biológico e Comportamental em Reclusos e Agentes em 22 Estabel` |
-| `source_resource` | `category` | Source resource title. | `BASE CARGA_VIRAL` |
-| `source_package_id` | `category` | CKAN package UUID. | `MOZ.INE.IBCRAEP.2024.vII` |
-| `source_resource_id` | `category` | CKAN resource UUID. | `moz-ine-nada-128-1160` |
-| `source_url` | `category` | Original source resource URL. | `https://mozdata.ine.gov.mz/index.php/catalog/128/download/1160` |
-| `license_id` | `category` | Source license identifier. | `other-open` |
-| `retrieved_at` | `category` | UTC retrieval timestamp. | `2026-08-07T20:33:37Z` |
+| `source_record_id` | `string` | Stable row identifier assigned during Electric Sheep Africa engineering. | `moz-ine-nada-128-1160:0` |
+| `country_iso3` | `dictionary<values=string, indices=int8, ordered=0>` | ISO3 country or area code. | `MOZ` |
+| `country_name` | `dictionary<values=string, indices=int8, ordered=0>` | Country or area name. | `Mozambique` |
+| `n_codparticipante` | `string` | Source column from the original resource. | `PRI0102M008` |
+| `cons_hiv` | `string` | Source column from the original resource. | `Sim` |
+| `cv_resul` | `string` | Source column from the original resource. | `detectavel` |
+| `cv_absoluto` | `double` | Source column from the original resource. | `400.0` |
+| `source_period_start_year` | `int64` | Start year inferred from source metadata. | `2023` |
+| `source_period_end_year` | `int64` | End year inferred from source metadata. | `2024` |
+| `source_period_label` | `dictionary<values=string, indices=int8, ordered=0>` | Source column from the original resource. | `2023-2024` |
+| `source_provider` | `dictionary<values=string, indices=int8, ordered=0>` | Publishing organization. | `Instituto Nacional de Saúde` |
+| `source_dataset` | `dictionary<values=string, indices=int8, ordered=0>` | Source dataset or package title. | `Inquérito Biológico e Comportamental em Reclusos e Agentes em 22 Esta...` |
+| `source_resource` | `dictionary<values=string, indices=int8, ordered=0>` | Source resource title, table name, or file name. | `BASE CARGA_VIRAL` |
+| `source_package_id` | `dictionary<values=string, indices=int8, ordered=0>` | Source package identifier. | `MOZ.INE.IBCRAEP.2024.vII` |
+| `source_resource_id` | `dictionary<values=string, indices=int8, ordered=0>` | Source resource identifier. | `moz-ine-nada-128-1160` |
+| `source_url` | `dictionary<values=string, indices=int8, ordered=0>` | Original source URL or download URL. | `https://mozdata.ine.gov.mz/index.php/catalog/128/download/1160` |
+| `license_id` | `dictionary<values=string, indices=int8, ordered=0>` | Source license identifier. | `other-open` |
+| `retrieved_at` | `dictionary<values=string, indices=int8, ordered=0>` | UTC source retrieval timestamp from the Electric Sheep Africa pipeline. | `2026-08-07T20:33:37Z` |
 
 ## Usage
 
@@ -93,51 +117,92 @@ df = ds["train"].to_pandas()
 print(df.head())
 ```
 
-### Filter to one country
+### Inspect Columns
 
 ```python
-sample_country = df[df["country_iso3"] == "MOZ"]
+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"] == "MOZ"]
 ```
 
+### 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
+
+- No canonical year/date column was detected in the packaged table; use source metadata and domain context for temporal interpretation.
+- 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:** [Instituto Nacional de Saúde](https://mozdata.ine.gov.mz/index.php/catalog/128/related-materials)
+- **Publisher:** Instituto Nacional de Saúde
+- **Portal:** [https://mozdata.ine.gov.mz](https://mozdata.ine.gov.mz)
+- **Resource:** [BASE CARGA_VIRAL](https://mozdata.ine.gov.mz/index.php/catalog/128/download/1160)
+- **License:** other-open
+- **Retrieved/generated:** `2026-08-07T20:51:44Z`
+- **Hugging Face repo:** [electricsheepafrica/africa-mozambique-inquerito-biologico-e-comportamental-em-reclusos-e-agentes-28a1baff](https://huggingface.co/datasets/electricsheepafrica/africa-mozambique-inquerito-biologico-e-comportamental-em-reclusos-e-agentes-28a1baff)
+
+## 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
+
+- Track mobility over time
+- Compare routes or geographies
+- Join with economic and population data
+- Check missingness before modeling
+- Use `country_iso3` as the safest geography join key when present
+
 ## Citation
 
 ```bibtex
 @misc{electric_sheep_africa_africa_mozambique_inquerito_biologico_e_comportamental_em_reclusos_e_agentes_28a_2024,
-  title        = {Inquérito Biológico e Comportamental em Reclusos e Agentes em 22 Estabelecimentos Penitenciários em Moçambique, 2023-Segunda Ronda | Africa (Mozambique official open data)},
+  title        = {Inquerito Biologico E Comportamental Em Reclusos E Agentes | Africa (Instituto Nacional de Saúde)},
   author       = {Instituto Nacional de Saúde},
   year         = {2024},
   url          = {https://mozdata.ine.gov.mz/index.php/catalog/128/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-mozambique-inquerito-biologico-e-comportamental-em-reclusos-e-agentes-28a1baff}}
 }
 ```
 
 ## License
 
-Released under [Other open license]().
-
-Original data (c) Instituto Nacional de Saúde. 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 Instituto Nacional de Saúde. 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-08-07 via the Electric Sheep pipeline. Source URL:
-https://mozdata.ine.gov.mz/index.php/catalog/128/download/1160
+Provenance: README standardized 2026-08-11 by the Electric Sheep Africa README system. Source URL: https://mozdata.ine.gov.mz/index.php/catalog/128/related-materials