Upload README.md with huggingface_hub

README.md

@@ -0,0 +1,186 @@
+---
+license: cc0-1.0
+task_categories:
+  - text-classification
+language:
+  - en
+tags:
+  - research
+  - affiliations
+  - ror
+  - datacite
+  - metadata
+  - scholarly-infrastructure
+pretty_name: DataCite Affiliations Matched to ROR
+size_categories:
+  - 100M<n<1B
+configs:
+  - config_name: doi_author_affiliations
+    data_files:
+      - split: train
+        path: data/doi_author_affiliations/*.parquet
+  - config_name: enriched_records
+    data_files:
+      - split: train
+        path: data/enriched_records/*.parquet
+  - config_name: ror_matches
+    data_files:
+      - split: train
+        path: data/ror_matches/*.parquet
+  - config_name: ror_matches_failed
+    data_files:
+      - split: train
+        path: data/ror_matches_failed/*.parquet
+  - config_name: unique_affiliations
+    data_files:
+      - split: train
+        path: data/unique_affiliations/*.parquet
+---
+
+# DataCite Affiliations Matched to ROR
+
+This dataset contains author affiliation data extracted from DataCite metadata records, matched against the Research Organization Registry (ROR).
+
+## Dataset Description
+
+- **Source:** [DataCite Public Data File](https://datacite.org/)
+- **ROR Version:** [v2.1-2026-01-15-ror-data](https://doi.org/10.5281/zenodo.18260365)
+- **Processing Tool:** [match-datacite-affiliations-to-ror-ids](https://github.com/cometadata/match-datacite-affiliations-to-ror-ids)
+- **Total Records:** 199,643,453
+- **Total Size:** 62.76 GB
+- **Match Rate:** 52.78%
+
+## Dataset Configurations
+
+| Configuration | Records | Size |
+|---------------|---------|------|
+| `doi_author_affiliations` | 158,351,335 | 30.54 GB |
+| `enriched_records` | 38,518,962 | 31.89 GB |
+| `ror_matches` | 731,798 | 134.62 MB |
+| `ror_matches_failed` | 654,780 | 91.80 MB |
+| `unique_affiliations` | 1,386,578 | 113.57 MB |
+
+## Configuration Details
+
+### `doi_author_affiliations`
+
+Flattened author-affiliation pairs extracted from DataCite records. Each row represents one author-affiliation relationship.
+
+**Schema:**
+- `doi` (string): The DOI of the work
+- `author_idx` (int): Index of the author within the work
+- `author_name` (string): Name of the author
+- `affiliation_idx` (int): Index of the affiliation for this author
+- `affiliation` (string): Raw affiliation string
+- `affiliation_hash` (string): MD5 hash of the normalized affiliation string
+
+### `enriched_records`
+
+Original DataCite records enriched with ROR IDs where matches were found.
+
+**Schema:**
+- `doi` (string): The DOI of the work
+- `creators` (list): List of creator objects with nested affiliation data including matched ROR IDs
+
+### `ror_matches`
+
+Successful affiliation-to-ROR matches.
+
+**Schema:**
+- `affiliation` (string): Raw affiliation string
+- `affiliation_hash` (string): MD5 hash of the normalized affiliation string
+- `ror_id` (string): Matched ROR ID
+
+### `ror_matches_failed`
+
+Affiliations that could not be matched to a ROR ID.
+
+**Schema:**
+- `affiliation` (string): Raw affiliation string
+- `affiliation_hash` (string): MD5 hash of the normalized affiliation string
+- `error` (string): Reason for match failure
+
+### `unique_affiliations`
+
+List of all unique affiliation strings found in the dataset.
+
+**Schema:**
+- `affiliation` (string): Raw affiliation string
+
+## Statistics
+
+### Top 20 Most Common Matched ROR IDs
+
+| ROR ID | Count |
+|--------|-------|
+| https://ror.org/01kzn7k21 | 8,097 |
+| https://ror.org/034t30j35 | 4,024 |
+| https://ror.org/036rp1748 | 2,798 |
+| https://ror.org/04y75dx46 | 2,730 |
+| https://ror.org/05qrfxd25 | 2,514 |
+| https://ror.org/01tmp8f25 | 1,948 |
+| https://ror.org/052gg0110 | 1,626 |
+| https://ror.org/05591te55 | 1,553 |
+| https://ror.org/02en5vm52 | 1,489 |
+| https://ror.org/042aqky30 | 1,455 |
+| https://ror.org/02kkvpp62 | 1,389 |
+| https://ror.org/03490as77 | 1,350 |
+| https://ror.org/04xfq0f34 | 1,322 |
+| https://ror.org/00rcxh774 | 1,248 |
+| https://ror.org/013meh722 | 1,211 |
+| https://ror.org/00987cb86 | 1,201 |
+| https://ror.org/011647w73 | 1,191 |
+| https://ror.org/05qbk4x57 | 1,184 |
+| https://ror.org/001w7jn25 | 1,179 |
+| https://ror.org/019qzkn95 | 1,177 |
+
+### Error Distribution (Failed Matches)
+
+| Error Type | Count |
+|------------|-------|
+| No match found | 654,775 |
+| HTTP 414 URI Too Long | 5 |
+
+## Usage
+
+```python
+from datasets import load_dataset
+
+# Load successful ROR matches
+matches = load_dataset("cometadata/datacite-affiliations-matched-ror", "ror_matches")
+
+# Load author-affiliation pairs (large dataset, use streaming)
+affiliations = load_dataset(
+    "cometadata/datacite-affiliations-matched-ror",
+    "doi_author_affiliations",
+    streaming=True
+)
+
+# Iterate over records
+for record in affiliations["train"]:
+    print(record["doi"], record["affiliation"])
+    break
+```
+
+## License
+
+This dataset is released under the [CC0 1.0 Universal (Public Domain Dedication)](https://creativecommons.org/publicdomain/zero/1.0/) license.
+
+## Citation
+
+If you use this dataset, please cite:
+
+```bibtex
+@dataset{datacite_affiliations_ror,
+  title = {DataCite Affiliations Matched to ROR},
+  author = {cometadata},
+  year = {2026},
+  publisher = {Hugging Face},
+  url = {https://huggingface.co/datasets/cometadata/datacite-affiliations-matched-ror}
+}
+```
+
+## Acknowledgments
+
+- [DataCite](https://datacite.org/) for providing the source metadata
+- [ROR](https://ror.org/) for the Research Organization Registry