Olaroti commited on
Commit
ba49d08
·
verified ·
1 Parent(s): 15868c0

Standardize Electric Sheep Africa dataset card

Browse files
Files changed (1) hide show
  1. README.md +97 -293
README.md CHANGED
@@ -1,342 +1,146 @@
1
  ---
 
2
  language:
3
  - en
4
- license: cc-by-nc-4.0
5
  task_categories:
6
  - tabular-classification
7
  - tabular-regression
8
- tags:
9
- - medical
10
- - oncology
11
- - breast-cancer
12
- - gene-expression
13
- - PAM50
14
- - Oncotype-DX
15
- - african-populations
16
- - synthetic-data
17
- - synthetic
18
  size_categories:
19
  - 10K<n<100K
20
- data_type: synthetic
21
- ---
22
-
23
- > ⚠️ **Synthetic dataset** — Parameterized from published SSA literature, not real observations. Not suitable for empirical analysis or policy inference.
24
-
25
- # Tumor Gene Expression Panels in African Breast Cancer
26
-
27
- **Dataset owner**: Electric Sheep Africa
28
- **Dataset type**: Synthetic tumor gene expression (Oncotype DX, PAM50, Ki-67)
29
- **Populations**: African and African-descent breast cancer patients
30
- **Version**: 1.0.0
31
- **License**: CC-BY-NC-4.0
32
-
33
- ---
34
-
35
- ## 1. Dataset Description
36
-
37
- This dataset provides **synthetic tumor gene expression profiles** for **50,000** breast cancer cases from **African and African-descent populations**, designed to mirror:
38
-
39
- - **Oncotype DX–equivalent recurrence scores** for ER+/HER2− tumors
40
- - **PAM50 molecular subtypes** (Luminal A/B, Basal-like, HER2-enriched, Normal-like)
41
- - **Proliferation markers**, including **Ki-67** and related genes
42
-
43
- All records are **fully synthetic** and were generated using an **internal, literature-driven synthetic data methodology**, with parameters derived from peer-reviewed literature on African and African-descent breast cancer cohorts.
44
-
45
- > **Important**: This dataset contains *no real patient data*. It is derived entirely from literature-based distributions and coherence rules.
46
-
47
- ---
48
-
49
- ## 2. Intended Use
50
-
51
- This dataset is intended for:
52
-
53
- - **Method development** for molecular subtyping (PAM50, IHC surrogates)
54
- - **Algorithm training** for Oncotype DX–like recurrence score prediction
55
- - **Proliferation and Ki-67 modeling** across African populations
56
- - **Health equity research** on differences in tumor biology by ancestry
57
- - **Education and benchmarking** in computational oncology
58
-
59
- Not intended for clinical decision-making or individual risk prediction.
60
-
61
- ---
62
-
63
- ## 3. Populations & Cohort Design
64
-
65
- ### 3.1 Populations
66
-
67
- The dataset includes 5 broad population groups, aligned with prior projects in this series:
68
-
69
- - **West_Africa** (e.g., Nigeria, Ghana, Senegal)
70
- - **East_Africa** (e.g., Kenya, Uganda, Ethiopia)
71
- - **Southern_Africa** (e.g., South Africa, Namibia, Botswana)
72
- - **Central_Africa** (e.g., Cameroon, DRC)
73
- - **African_American** (USA)
74
-
75
- ### 3.2 Sample Size
76
-
77
- - **Total samples**: 50,000 synthetic tumors
78
- - **Approximate population fractions**:
79
- - West_Africa: 25%
80
- - East_Africa: 20%
81
- - Southern_Africa: 15%
82
- - Central_Africa: 10%
83
- - African_American: 30%
84
-
85
- ---
86
-
87
- ## 4. Molecular Features
88
-
89
- ### 4.1 PAM50 Molecular Subtypes
90
-
91
- Each sample is assigned a **PAM50-like molecular subtype**:
92
-
93
- - **Luminal_A**
94
- - **Luminal_B**
95
- - **Basal_like**
96
- - **HER2_enriched**
97
- - **Normal_like**
98
-
99
- The distribution is **African-enriched for basal-like tumors**, reflecting the literature:
100
-
101
- - Basal_like: ~40%
102
- - Luminal_A: ~35%
103
- - Luminal_B: ~17%
104
- - HER2_enriched: ~8%
105
- - Normal_like: ~1–2%
106
-
107
- ### 4.2 Receptor Status
108
-
109
- Immunohistochemistry-style receptor status is included:
110
-
111
- - `ER_status`: Positive / Negative
112
- - `PR_status`: Positive / Negative
113
- - `HER2_status`: Positive / Negative
114
- - `is_TNBC`: Triple-negative (ER−/PR−/HER2−)
115
-
116
- Triple-negative tumors (TNBC) are enriched (~35–40%) to reflect African cohorts.
117
-
118
- ### 4.3 Gene Expression Features (Key Subset)
119
-
120
- All expression values are on a **log2(normalized expression + 1)** scale.
121
-
122
- This initial public version exposes a **key subset of genes** for transparency and compactness:
123
-
124
- - **Proliferation marker**:
125
- - `MKI67_expr` – Ki-67
126
- - **Hormone receptor signaling**:
127
- - `ESR1_expr` – Estrogen receptor
128
- - `PGR_expr` – Progesterone receptor
129
- - **HER2 pathway**:
130
- - `ERBB2_expr` – HER2 receptor
131
- - **Basal markers**:
132
- - `KRT5_expr`, `KRT17_expr` – Basal cytokeratins
133
-
134
- Future versions may expose additional genes from the **Oncotype DX** and **PAM50** panels in a companion dataset.
135
-
136
- ### 4.4 Proliferation (Ki-67)
137
-
138
- - `ki67_percentage` – Estimated Ki-67 labeling index (0–100%)
139
- - `ki67_category` – {`Low` (<14%), `Intermediate` (14–30%), `High` (>30%)}
140
-
141
- African and African-descent populations show **higher Ki-67**, particularly in basal-like and high-grade tumors.
142
-
143
- ### 4.5 Oncotype DX–Equivalent Score
144
-
145
- For **ER+/HER2− tumors**, we provide a **simplified Oncotype DX–like recurrence score**:
146
-
147
- - `oncotype_RS` – Integer score from 0–100
148
- - `oncotype_risk_category` – {`Low`, `Intermediate`, `High`, `Not_applicable`}
149
-
150
- The risk distribution is calibrated from published literature on African American and multi-ethnic cohorts.
151
-
152
- ---
153
-
154
- ## 5. Main File Schema
155
-
156
- ### 5.1 `gene_expression_data.csv`
157
-
158
- - **Rows**: 50,000 samples
159
- - **Columns** (23 variables):
160
-
161
- Demographics & clinical:
162
- - `sample_id` – Synthetic ID (`BC_EXPR_00000` ...)
163
- - `population` – One of 5 population groups
164
- - `age` – Age in years (25–85)
165
- - `age_group` – {`<40`, `40-49`, `50-59`, `60+`}
166
- - `menopausal_status` – {`Premenopausal`, `Postmenopausal`}
167
- - `bmi` – Body mass index (kg/m²)
168
- - `tumor_grade` – {1, 2, 3}
169
- - `stage` – {`I`, `II`, `III`}
170
-
171
- Molecular subtypes and receptors:
172
- - `pam50_subtype` – {`Luminal_A`, `Luminal_B`, `Basal_like`, `HER2_enriched`, `Normal_like`}
173
- - `ER_status` – {`Positive`, `Negative`}
174
- - `PR_status` – {`Positive`, `Negative`}
175
- - `HER2_status` – {`Positive`, `Negative`}
176
- - `is_TNBC` – Boolean (triple-negative)
177
-
178
- Key gene expression values (log2 scale):
179
- - `MKI67_expr` – Ki-67
180
- - `ESR1_expr` – Estrogen receptor
181
- - `PGR_expr` – Progesterone receptor
182
- - `ERBB2_expr` – HER2 receptor
183
- - `KRT5_expr`, `KRT17_expr` – Basal cytokeratins
184
-
185
- Derived scores:
186
- - `ki67_percentage` – Ki-67 proliferation index (%)
187
- - `ki67_category` – {`Low`, `Intermediate`, `High`}
188
- - `oncotype_RS` – Oncotype-like recurrence score (0–100, NaN if not applicable)
189
- - `oncotype_risk_category` – {`Low`, `Intermediate`, `High`, `Not_applicable`}
190
-
191
- ---
192
-
193
- ## 6. Data Access & Files
194
-
195
- ### Main Dataset (root)
196
-
197
- - **`gene_expression_data.csv`** – 50,000 × 23 variables (main table, CSV)
198
- - **`gene_expression_data.parquet`** – Same table in Parquet format for efficient loading.
199
-
200
- ### Auxiliary Files
201
-
202
- At this time, auxiliary summary tables and the full validation report are not distributed as separate files in this repository. Key validation findings and literature sources are summarized in this dataset card.
203
-
204
  ---
205
 
206
- ## 7. Generation Methodology (Summary)
207
 
208
- The dataset was generated using an **internal, literature-driven synthetic data framework**, following a structured multi-phase pipeline:
209
 
210
- 1. **Domain specification** – Define gene panels (Oncotype DX, PAM50, Ki-67) and African focus.
211
- 2. **Literature review** – Extract subtype frequencies, Ki-67 levels, and score distributions from 30+ studies.
212
- 3. **Parameter configuration** – Encode all parameters in YAML (`gene_expression_config.yaml`).
213
- 4. **Generation** – Use a reproducible Python generator to simulate 50,000 cases.
214
- 5. **Validation** – Run `scripts/validate_gene_expression.py` to check distributions, coherence, and correlations (30 checks).
215
- 6. **Documentation** – Create dataset card and usage examples.
216
- 7. **Release** – Upload to Hugging Face with CC-BY-NC-4.0.
217
 
218
- ### 7.1 Key Modeling Choices
219
 
220
- - **PAM50 subtypes** assigned using population-specific target proportions.
221
- - **Receptor status** inferred from subtypes with high concordance (e.g., Basal_like ↔ TNBC).
222
- - **Gene expression values** drawn from subtype-specific normal distributions calibrated to literature and TCGA-like ranges.
223
- - **Ki-67** modeled as a function of subtype, population multiplier, and MKI67 expression.
224
- - **Oncotype DX scores** simulated for ER+/HER2− tumors using population and subtype–dependent distributions.
225
 
226
- ---
227
 
228
- ## 8. Validation Status
229
 
230
- - This dataset has been validated using `scripts/validate_gene_expression.py` on the released CSV.
231
 
232
- - **Generation completed** for 50,000 samples.
233
- - ✅ **30 validation checks** executed (structure, distributions, coherence).
234
- - ✅ **Results**: 25 `PASS`, 5 `WARN`, 0 `FAIL`.
235
- - ✅ **Validation report**: maintained internally; main findings are summarized below.
236
 
237
- Key validation themes include:
 
 
 
 
 
 
 
 
 
 
 
238
 
239
- - Distributions vs literature (subtypes, TNBC, Ki-67, Oncotype)
240
- - Expression ranges and subtype-specific patterns
241
- - ER/ESR1 and HER2/ERBB2 concordance
242
- - Basal-like ↔ TNBC overlap
243
- - Ki-67 correlation with MKI67 expression and grade
244
-
245
- ---
246
 
247
- ## 9. Example Usage
 
 
 
248
 
249
- ### 9.1 Load with pandas
250
-
251
- ```python
252
- import pandas as pd
253
-
254
- df = pd.read_csv("gene_expression_data.csv")
255
- print(df.shape)
256
- print(df.head())
257
- ```
258
-
259
- ### 9.2 Load with `datasets`
260
 
261
  ```python
262
  from datasets import load_dataset
263
 
264
- dataset = load_dataset("electricsheepafrica/tumor-gene-expression-african")
265
- df = dataset["train"].to_pandas()
266
 
267
- print(f"Samples: {len(df)}")
268
- print(f"Columns: {len(df.columns)}")
 
 
269
  ```
270
 
271
- ### 9.3 Simple Analysis: PAM50 Subtypes
272
 
273
  ```python
274
- subtype_counts = df["pam50_subtype"].value_counts(normalize=True) * 100
275
- print(subtype_counts)
276
- ```
277
 
278
- ### 9.4 Ki-67 by Subtype
279
-
280
- ```python
281
- ki67_by_subtype = df.groupby("pam50_subtype")["ki67_percentage"].describe()
282
- print(ki67_by_subtype)
283
  ```
284
 
285
- ### 9.5 Oncotype DX Risk in ER+/HER2− Tumors
286
 
287
- ```python
288
- mask = (df["ER_status"] == "Positive") & (df["HER2_status"] == "Negative")
289
- rs = df.loc[mask, "oncotype_RS"]
 
290
 
291
- print(rs.describe())
292
- print(df.loc[mask, "oncotype_risk_category"].value_counts(normalize=True) * 100)
293
- ```
294
 
295
- ---
 
 
 
 
296
 
297
- ## 10. Ethical & Appropriate Use
298
 
299
- ### 10.1 Appropriate Uses
 
 
 
300
 
301
- - Method development and benchmarking
302
- - Educational demos and tutorials
303
- - Health equity and disparity analysis (synthetic)
304
- - Robustness testing for molecular classifiers
305
 
306
- ### 10.2 Inappropriate Uses ❌
307
-
308
- - Clinical decision-making for individual patients
309
- - Real-world prognosis or treatment selection
310
- - Insurance, employment, or financial decisions
311
- - Genetic ancestry inference at the individual level
312
-
313
- This dataset is **synthetic** and must not be used as a substitute for real clinical or genomic data in patient care.
314
-
315
- ---
316
-
317
- ## 11. License
318
 
319
- - **License**: CC-BY-NC-4.0
320
- - **Commercial use**: Not permitted without explicit permission.
321
 
322
- If you use this dataset in academic or non-commercial work, please cite as below.
323
 
324
- ---
325
 
326
- ## 12. Citation
327
 
328
- ```text
329
- Electric Sheep Africa (2025).
330
- Tumor Gene Expression Panels in African Breast Cancer (Synthetic Dataset).
331
- Generated using an internal, literature-driven synthetic data methodology.
332
- Hugging Face Datasets. Version 1.0.0.
333
- ```
334
 
335
  ---
336
 
337
- ## 13. Contact
338
-
339
- - **Organization**: Electric Sheep Africa
340
- - **Hugging Face**: https://huggingface.co/electricsheepafrica
341
-
342
- Feedback and collaboration inquiries are welcome.
 
1
  ---
2
+ license: other
3
  language:
4
  - en
 
5
  task_categories:
6
  - tabular-classification
7
  - tabular-regression
8
+ multilinguality: monolingual
 
 
 
 
 
 
 
 
 
9
  size_categories:
10
  - 10K<n<100K
11
+ tags:
12
+ - "africa"
13
+ - "electric-sheep-africa"
14
+ - "open-data"
15
+ - "metadata-backed"
16
+ - "health"
17
+ - "parquet"
18
+ - "tabular"
19
+ - "text"
20
+ - "medical"
21
+ - "oncology"
22
+ - "breast-cancer"
23
+ - "gene-expression"
24
+ - "pam50"
25
+ - "oncotype-dx"
26
+ - "african-populations"
27
+ - "synthetic-data"
28
+ - "synthetic"
29
+ - "cancer"
30
+ pretty_name: "Africa Synth Population Tumor Gene Expression African All | Africa (Electric Sheep Africa metadata inventory)"
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
31
  ---
32
 
33
+ # Africa Synth Population Tumor Gene Expression African All | Africa (Electric Sheep Africa metadata inventory)
34
 
35
+ **Size category:** `10K<n<100K` - **Formats:** `parquet` - **Sector:** health - *Engineered by [Electric Sheep Africa](https://huggingface.co/electricsheepafrica)*
36
 
37
+ ![size](https://img.shields.io/badge/size-10K%3Cn%3C100K-blue)
38
+ ![sector](https://img.shields.io/badge/sector-health-green)
39
+ ![downloads](https://img.shields.io/badge/HF_downloads-109-orange)
40
+ ![license](https://img.shields.io/badge/license-other-lightgrey)
 
 
 
41
 
42
+ ## TL;DR
43
 
44
+ This dataset is part of the Electric Sheep Africa catalog on Hugging Face. It is indexed for African data discovery with standardized metadata, loading guidance, provenance notes, and analyst-oriented context.
 
 
 
 
45
 
46
+ ## What This Dataset Covers
47
 
48
+ Health datasets help researchers examine disease burden, service delivery, risk factors, outcomes, and public-health program performance.
49
 
50
+ Dataset context from the existing Hugging Face card: ⚠️ Synthetic dataset — Parameterized from published SSA literature, not real observations. Not suitable for empirical analysis or policy inference. Tumor Gene Expression Panels in African Breast Cancer Dataset owner: Electric Sheep AfricaDataset type: Synthetic tumor gene expression (Oncotype DX, PAM50, Ki-67)Populations: African and African-descent breast cancer patientsVersion: 1.0.0License: CC-BY-NC-4.0 1. Dataset Description This dataset provides synthetic tumor… See the full description on the dataset page: https://huggingface.co/datasets/electricsheepafrica/africa-synth-population-tumor-gene-expression-african-all.
51
 
52
+ ## Dataset Profile
 
 
 
53
 
54
+ | Field | Value |
55
+ |---|---|
56
+ | Hugging Face repo | [`electricsheepafrica/africa-synth-population-tumor-gene-expression-african-all`](https://huggingface.co/datasets/electricsheepafrica/africa-synth-population-tumor-gene-expression-african-all) |
57
+ | Sector | health |
58
+ | Topic tags | medical, oncology, breast-cancer, gene-expression, PAM50, Oncotype-DX, african-populations, synthetic-data, synthetic |
59
+ | Modalities | `tabular`, `text` |
60
+ | Formats | `parquet` |
61
+ | Size category | `10K<n<100K` |
62
+ | Countries | Africa-wide or source-defined African coverage |
63
+ | ISO3 coverage | `not declared` |
64
+ | Last modified on HF | `2026-04-14 22:38:41+00:00` |
65
+ | Inventory snapshot | `2026-07-16T16:00:34Z` |
66
 
67
+ ## How To Read This Dataset
 
 
 
 
 
 
68
 
69
+ - Start from the repository files and the dataset viewer when available.
70
+ - Treat the README context as a fast orientation layer; confirm variable definitions and units in the data files before modeling.
71
+ - Use explicit country columns when present. When geography is only implied by the title or source metadata, document that assumption in downstream analysis.
72
+ - Preserve missing values until you have a defensible imputation rule.
73
 
74
+ ## Usage
 
 
 
 
 
 
 
 
 
 
75
 
76
  ```python
77
  from datasets import load_dataset
78
 
79
+ ds = load_dataset("electricsheepafrica/africa-synth-population-tumor-gene-expression-african-all")
80
+ print(ds)
81
 
82
+ split_name = next(iter(ds))
83
+ table = ds[split_name]
84
+ print(table.features)
85
+ print(table[:3])
86
  ```
87
 
88
+ ### Convert To Pandas When Tabular
89
 
90
  ```python
91
+ from datasets import Dataset
 
 
92
 
93
+ first_split = ds[next(iter(ds))]
94
+ if isinstance(first_split, Dataset):
95
+ df = first_split.to_pandas()
96
+ print(df.head())
 
97
  ```
98
 
99
+ ## Data Quality Notes
100
 
101
+ - This card was standardized from the Electric Sheep Africa Hugging Face metadata inventory.
102
+ - Exact schema, row counts, and source files should be inspected in the repository data files.
103
+ - Metadata gaps from the inventory: country, upstream_publisher.
104
+ - Do not infer policy meaning from labels alone; confirm definitions, units, and methods in the source material.
105
 
106
+ ## Source And Provenance
 
 
107
 
108
+ - **Source context:** Electric Sheep Africa metadata inventory
109
+ - **Publisher/source attribution:** Public dataset metadata
110
+ - **License:** cc-by-nc-4.0
111
+ - **Hugging Face URL:** [https://huggingface.co/datasets/electricsheepafrica/africa-synth-population-tumor-gene-expression-african-all](https://huggingface.co/datasets/electricsheepafrica/africa-synth-population-tumor-gene-expression-african-all)
112
+ - **Inventory retrieved at:** `2026-07-16T16:00:34Z`
113
 
114
+ ## Suggested Analyses
115
 
116
+ - Inspect schema and missingness before modeling.
117
+ - Profile variables by geography, time, and subgroup columns where present.
118
+ - Join with other Electric Sheep Africa datasets using explicit country, year, and indicator fields when available.
119
+ - Build reproducible notebooks that cite both the original source context and the Electric Sheep Africa Hugging Face repo.
120
 
121
+ ## Citation
 
 
 
122
 
123
+ ```bibtex
124
+ @misc{electric_sheep_africa_africa_synth_population_tumor_gene_expression_african_all_2026,
125
+ title = {Africa Synth Population Tumor Gene Expression African All | Africa (Electric Sheep Africa metadata inventory)},
126
+ author = {Public dataset metadata},
127
+ year = {2026},
128
+ url = {https://huggingface.co/datasets/electricsheepafrica/africa-synth-population-tumor-gene-expression-african-all},
129
+ publisher = {Hugging Face Datasets, engineered by Electric Sheep Africa},
130
+ howpublished = {\url{https://huggingface.co/datasets/electricsheepafrica/africa-synth-population-tumor-gene-expression-african-all}}
131
+ }
132
+ ```
 
 
133
 
134
+ ## License
 
135
 
136
+ Released under cc-by-nc-4.0.
137
 
138
+ Original source rights remain with the original publisher or data provider. Electric Sheep Africa engineering standardizes discovery metadata, documentation, and usage guidance for analysis on Hugging Face.
139
 
140
+ ## About Electric Sheep Africa
141
 
142
+ Electric Sheep Africa publishes ML-ready African public datasets on Hugging Face.
 
 
 
 
 
143
 
144
  ---
145
 
146
+ Provenance: metadata-backed README standardized 2026-08-12 by the Electric Sheep Africa README system. Inventory source: `catalog/esa_metadata_inventory/master_metadata.jsonl`.