Upload README.md with huggingface_hub
Browse files
README.md
CHANGED
|
@@ -1,147 +1,154 @@
|
|
| 1 |
---
|
| 2 |
-
license:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 3 |
---
|
| 4 |
|
| 5 |
-
|
| 6 |
-
# Dataset Card for Dataset Name
|
| 7 |
-
Dataset Details
|
| 8 |
-
Dataset Description
|
| 9 |
|
| 10 |
-
|
| 11 |
|
| 12 |
-
|
| 13 |
-
<!-- Provide a quick summary of the dataset. -->
|
| 14 |
|
| 15 |
-
|
| 16 |
|
| 17 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
| 18 |
|
| 19 |
-
##
|
| 20 |
|
| 21 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
| 22 |
|
|
|
|
| 23 |
|
|
|
|
| 24 |
|
| 25 |
-
|
| 26 |
-
- **Funded by [optional]:** [More Information Needed]
|
| 27 |
-
- **Shared by [optional]:** [More Information Needed]
|
| 28 |
-
- **Language(s) (NLP):** [More Information Needed]
|
| 29 |
-
- **License:** [More Information Needed]
|
| 30 |
|
| 31 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 32 |
|
| 33 |
-
|
| 34 |
|
| 35 |
-
|
| 36 |
-
- **Paper [optional]:** [More Information Needed]
|
| 37 |
-
- **Demo [optional]:** [More Information Needed]
|
| 38 |
|
| 39 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 40 |
|
| 41 |
-
|
| 42 |
|
| 43 |
-
|
| 44 |
|
| 45 |
-
|
| 46 |
|
| 47 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 48 |
|
| 49 |
-
##
|
| 50 |
|
| 51 |
-
|
|
|
|
|
|
|
| 52 |
|
| 53 |
-
|
|
|
|
|
|
|
| 54 |
|
| 55 |
-
#
|
|
|
|
|
|
|
|
|
|
| 56 |
|
| 57 |
-
|
| 58 |
|
| 59 |
-
|
|
|
|
|
|
|
| 60 |
|
| 61 |
-
##
|
| 62 |
|
| 63 |
-
|
| 64 |
-
|
| 65 |
-
<!-- Motivation for the creation of this dataset. -->
|
| 66 |
-
|
| 67 |
-
[More Information Needed]
|
| 68 |
-
|
| 69 |
-
### Source Data
|
| 70 |
-
|
| 71 |
-
<!-- This section describes the source data (e.g. news text and headlines, social media posts, translated sentences, ...). -->
|
| 72 |
-
|
| 73 |
-
#### Data Collection and Processing
|
| 74 |
-
|
| 75 |
-
<!-- This section describes the data collection and processing process such as data selection criteria, filtering and normalization methods, tools and libraries used, etc. -->
|
| 76 |
-
|
| 77 |
-
[More Information Needed]
|
| 78 |
-
|
| 79 |
-
#### Who are the source data producers?
|
| 80 |
-
|
| 81 |
-
<!-- This section describes the people or systems who originally created the data. It should also include self-reported demographic or identity information for the source data creators if this information is available. -->
|
| 82 |
-
|
| 83 |
-
[More Information Needed]
|
| 84 |
-
|
| 85 |
-
### Annotations [optional]
|
| 86 |
-
|
| 87 |
-
<!-- If the dataset contains annotations which are not part of the initial data collection, use this section to describe them. -->
|
| 88 |
-
|
| 89 |
-
#### Annotation process
|
| 90 |
-
|
| 91 |
-
<!-- This section describes the annotation process such as annotation tools used in the process, the amount of data annotated, annotation guidelines provided to the annotators, interannotator statistics, annotation validation, etc. -->
|
| 92 |
-
|
| 93 |
-
[More Information Needed]
|
| 94 |
-
|
| 95 |
-
#### Who are the annotators?
|
| 96 |
-
|
| 97 |
-
<!-- This section describes the people or systems who created the annotations. -->
|
| 98 |
-
|
| 99 |
-
[More Information Needed]
|
| 100 |
-
|
| 101 |
-
#### Personal and Sensitive Information
|
| 102 |
-
|
| 103 |
-
<!-- State whether the dataset contains data that might be considered personal, sensitive, or private (e.g., data that reveals addresses, uniquely identifiable names or aliases, racial or ethnic origins, sexual orientations, religious beliefs, political opinions, financial or health data, etc.). If efforts were made to anonymize the data, describe the anonymization process. -->
|
| 104 |
-
|
| 105 |
-
[More Information Needed]
|
| 106 |
-
|
| 107 |
-
## Bias, Risks, and Limitations
|
| 108 |
-
|
| 109 |
-
<!-- This section is meant to convey both technical and sociotechnical limitations. -->
|
| 110 |
-
|
| 111 |
-
[More Information Needed]
|
| 112 |
-
|
| 113 |
-
### Recommendations
|
| 114 |
-
|
| 115 |
-
<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
|
| 116 |
-
|
| 117 |
-
Users should be made aware of the risks, biases and limitations of the dataset. More information needed for further recommendations.
|
| 118 |
-
|
| 119 |
-
## Citation [optional]
|
| 120 |
-
|
| 121 |
-
<!-- If there is a paper or blog post introducing the dataset, the APA and Bibtex information for that should go in this section. -->
|
| 122 |
-
|
| 123 |
-
**BibTeX:**
|
| 124 |
-
|
| 125 |
-
[More Information Needed]
|
| 126 |
-
|
| 127 |
-
**APA:**
|
| 128 |
-
|
| 129 |
-
[More Information Needed]
|
| 130 |
-
|
| 131 |
-
## Glossary [optional]
|
| 132 |
-
|
| 133 |
-
<!-- If relevant, include terms and calculations in this section that can help readers understand the dataset or dataset card. -->
|
| 134 |
-
|
| 135 |
-
[More Information Needed]
|
| 136 |
-
|
| 137 |
-
## More Information [optional]
|
| 138 |
-
|
| 139 |
-
[More Information Needed]
|
| 140 |
-
|
| 141 |
-
## Dataset Card Authors [optional]
|
| 142 |
-
|
| 143 |
-
[More Information Needed]
|
| 144 |
-
|
| 145 |
-
## Dataset Card Contact
|
| 146 |
-
|
| 147 |
-
[More Information Needed]
|
|
|
|
| 1 |
---
|
| 2 |
+
license: cc-by-4.0
|
| 3 |
+
task_categories:
|
| 4 |
+
- other
|
| 5 |
+
tags:
|
| 6 |
+
- biology
|
| 7 |
+
- protein
|
| 8 |
+
- structure
|
| 9 |
+
- PDB
|
| 10 |
+
- PISCES
|
| 11 |
+
- CullPDB
|
| 12 |
+
- sequence
|
| 13 |
+
- curation
|
| 14 |
+
language: en
|
| 15 |
+
size_categories:
|
| 16 |
+
- n>1M
|
| 17 |
+
dataset_info:
|
| 18 |
+
config_name: default
|
| 19 |
+
features:
|
| 20 |
+
- name: pdb_chain
|
| 21 |
+
dtype: string
|
| 22 |
+
- name: pdb
|
| 23 |
+
dtype: string
|
| 24 |
+
- name: chain
|
| 25 |
+
dtype: string
|
| 26 |
+
- name: sequence
|
| 27 |
+
dtype: string
|
| 28 |
+
- name: len
|
| 29 |
+
dtype: int64
|
| 30 |
+
- name: method
|
| 31 |
+
dtype: string
|
| 32 |
+
- name: resolution
|
| 33 |
+
dtype: float64
|
| 34 |
+
- name: rfac
|
| 35 |
+
dtype: string
|
| 36 |
+
- name: freerfac
|
| 37 |
+
dtype: string
|
| 38 |
+
- name: pc
|
| 39 |
+
dtype: float64
|
| 40 |
+
- name: no_breaks
|
| 41 |
+
dtype: string
|
| 42 |
+
- name: R
|
| 43 |
+
dtype: float64
|
| 44 |
+
- name: source_list
|
| 45 |
+
dtype: string
|
| 46 |
+
splits: null
|
| 47 |
+
num_rows: 4540884
|
| 48 |
+
# Main and index paths; full list of subset paths is in dataset_metadata.json
|
| 49 |
+
data_paths:
|
| 50 |
+
main_csv: curated_csv/cullpdb_combined_chains.csv
|
| 51 |
+
index_csv: curated_csv/cullpdb_list_fasta_index.csv
|
| 52 |
+
full_list_csv: curated_csv/cullpdb_full_compiled_list.csv
|
| 53 |
+
subsets_dir: curated_csv/subsets
|
| 54 |
+
metadata: curated_csv/dataset_metadata.json
|
| 55 |
---
|
| 56 |
|
| 57 |
+
# PISCES-CulledPDB — Curated chain CSVs
|
|
|
|
|
|
|
|
|
|
| 58 |
|
| 59 |
+
Curated protein chain tables derived from PISCES/CullPDB-style lists and FASTA files. One row per chain with sequence, metadata, and curation parameters.
|
| 60 |
|
| 61 |
+
**Dataset:** [PRMegathon26/PISCES-CulledPDB](https://huggingface.co/datasets/PRMegathon26/PISCES-CulledPDB)
|
|
|
|
| 62 |
|
| 63 |
+
## Dataset Summary
|
| 64 |
|
| 65 |
+
| Item | Description |
|
| 66 |
+
|------|-------------|
|
| 67 |
+
| **Main CSV** | `curated_csv/cullpdb_combined_chains.csv` — single table with **4,540,884** chains (one row per chain). |
|
| 68 |
+
| **Subset CSVs** | `curated_csv/subsets/*.csv` — **242** files, one per curation subset (same columns as main). |
|
| 69 |
+
| **Index** | `curated_csv/cullpdb_list_fasta_index.csv` — **242** rows; maps subset basenames to list/FASTA paths and parameters. |
|
| 70 |
|
| 71 |
+
## Data paths (metadata)
|
| 72 |
|
| 73 |
+
**Main and index files:**
|
| 74 |
+
- `curated_csv/cullpdb_combined_chains.csv` — master chain table
|
| 75 |
+
- `curated_csv/cullpdb_list_fasta_index.csv` — subset index
|
| 76 |
+
- `curated_csv/cullpdb_full_compiled_list.csv` — full compiled list
|
| 77 |
+
- `curated_csv/subsets/` — directory containing one CSV per subset (**242** files)
|
| 78 |
|
| 79 |
+
**Subset paths:** The full list of subset CSV paths is in **`curated_csv/dataset_metadata.json`** (keys `data_paths` and `subset_paths`). Use it for programmatic listing or with `hf_hub_download(..., filename=path)`.
|
| 80 |
|
| 81 |
+
## Main CSV & Subset CSV — Column definitions
|
| 82 |
|
| 83 |
+
Each chain row has the following columns:
|
|
|
|
|
|
|
|
|
|
|
|
|
| 84 |
|
| 85 |
+
| Column | Type | Description |
|
| 86 |
+
|--------|------|-------------|
|
| 87 |
+
| **pdb_chain** | string/number | PDB chain ID (e.g. 1ABC_A) |
|
| 88 |
+
| **pdb** | string/number | PDB ID (first 4 chars) |
|
| 89 |
+
| **chain** | string/number | Chain ID |
|
| 90 |
+
| **sequence** | string/number | Amino acid sequence (one-letter) |
|
| 91 |
+
| **len** | string/number | Sequence length |
|
| 92 |
+
| **method** | string/number | Experimental method (e.g. XRAY, NMR) |
|
| 93 |
+
| **resolution** | string/number | Resolution in Å (per structure) |
|
| 94 |
+
| **rfac** | string/number | R-factor |
|
| 95 |
+
| **freerfac** | string/number | Free R-factor |
|
| 96 |
+
| **pc** | string/number | Sequence identity cutoff % used for this subset |
|
| 97 |
+
| **no_breaks** | string/number | Whether chain has no breaks (yes/no) |
|
| 98 |
+
| **R** | string/number | R-factor cutoff used for this subset |
|
| 99 |
+
| **source_list** | string/number | Subset list basename (identifies curation parameters) |
|
| 100 |
|
| 101 |
+
Subset CSVs use the same schema; each file corresponds to one row in the index (one set of parameters: pc, resolution range, no_breaks, R, Nmethods).
|
| 102 |
|
| 103 |
+
## Index CSV — Column definitions
|
|
|
|
|
|
|
| 104 |
|
| 105 |
+
| Column | Description |
|
| 106 |
+
|--------|-------------|
|
| 107 |
+
| **list_basename** | Subset list basename |
|
| 108 |
+
| **fasta_basename** | Corresponding FASTA basename |
|
| 109 |
+
| **list_path** | Full path to list file |
|
| 110 |
+
| **fasta_path** | Full path to FASTA file |
|
| 111 |
+
| **n_chains** | Number of chains in this subset |
|
| 112 |
+
| **pc** | Sequence identity cutoff % |
|
| 113 |
+
| **resolution** | Resolution range (e.g. 0.0-2.0) |
|
| 114 |
+
| **no_breaks** | yes/no |
|
| 115 |
+
| **R** | R-factor cutoff |
|
| 116 |
+
| **Nmethods** | Experiment types (e.g. Xray, Xray+EM) |
|
| 117 |
|
| 118 |
+
## Subset naming
|
| 119 |
|
| 120 |
+
Subset list basenames follow:
|
| 121 |
|
| 122 |
+
`cullpdb_pc{pc}_res{min}-{max}_[noBrks_]len40-10000_R{R}_{Nmethods}_..._chains{N}`
|
| 123 |
|
| 124 |
+
- **pc**: sequence identity cutoff (%)
|
| 125 |
+
- **resolution**: Å range (e.g. 0.0–2.0)
|
| 126 |
+
- **noBrks** (optional): no breaks in chain
|
| 127 |
+
- **R**: R-factor cutoff
|
| 128 |
+
- **Nmethods**: Xray, Xray+EM, or Xray+Nmr+EM
|
| 129 |
+
- **N**: number of chains in that subset
|
| 130 |
|
| 131 |
+
## Usage
|
| 132 |
|
| 133 |
+
```python
|
| 134 |
+
from huggingface_hub import hf_hub_download
|
| 135 |
+
import pandas as pd
|
| 136 |
|
| 137 |
+
# Download main CSV (large)
|
| 138 |
+
path = hf_hub_download(repo_id="PRMegathon26/PISCES-CulledPDB", filename="curated_csv/cullpdb_combined_chains.csv", repo_type="dataset")
|
| 139 |
+
df = pd.read_csv(path)
|
| 140 |
|
| 141 |
+
# Or load a single subset
|
| 142 |
+
path = hf_hub_download(repo_id="PRMegathon26/PISCES-CulledPDB", filename="curated_csv/subsets/cullpdb_pc20.0_res0.0-1.0_len40-10000_R0.2_Xray_d2026_01_26_chains314.csv", repo_type="dataset")
|
| 143 |
+
df = pd.read_csv(path)
|
| 144 |
+
```
|
| 145 |
|
| 146 |
+
## Curation workflow
|
| 147 |
|
| 148 |
+
1. **Index**: List/FASTA pairs scanned → `cullpdb_list_fasta_index.csv`
|
| 149 |
+
2. **Build**: For each index row, list and FASTA aligned 1:1 → one chain CSV per subset + combined master CSV
|
| 150 |
+
3. **Filter/visualize**: Optional filtering and summary figures from the master CSV
|
| 151 |
|
| 152 |
+
## License
|
| 153 |
|
| 154 |
+
CC BY 4.0 (or as specified in the repo).
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|