MaziyarPanahi commited on
Commit
2139560
·
verified ·
1 Parent(s): 20054e1

Consistent README with dataset card

Browse files
Files changed (1) hide show
  1. README.md +53 -60
README.md CHANGED
@@ -1,38 +1,39 @@
1
  ---
2
  license: cc-by-4.0
3
  task_categories:
4
- - tabular-regression
5
- - tabular-classification
6
  tags:
7
- - gwas
8
- - summary-statistics
9
- - psychiatric-genomics
10
- - pgc
11
- - adhd
12
- - mental-health
13
- - genetics
14
- - genomics
15
- pretty_name: PGC Attention Deficit Hyperactivity Disorder GWAS Summary Statistics
 
16
  size_categories:
17
- - 1M-10M
18
  configs:
19
- - config_name: adhd2010
20
- data_files:
21
- - split: train
22
- path: data/adhd2010/*.parquet
23
- default: true
24
- - config_name: adhd2018_SexSpecific
25
- data_files:
26
- - split: train
27
- path: data/adhd2018_SexSpecific/*.parquet
28
- - config_name: adhd2019
29
- data_files:
30
- - split: train
31
- path: data/adhd2019/*.parquet
32
- - config_name: adhd2022
33
- data_files:
34
- - split: train
35
- path: data/adhd2022/*.parquet
36
  ---
37
 
38
  # PGC Attention Deficit Hyperactivity Disorder — GWAS Summary Statistics
@@ -43,75 +44,67 @@ configs:
43
 
44
  Genome-wide association study (GWAS) summary statistics for **Attention Deficit Hyperactivity Disorder** phenotypes from the [Psychiatric Genomics Consortium (PGC)](https://pgc.unc.edu/).
45
 
46
- This dataset contains multiple GWAS publications as separate subsets (configs). Each can be loaded independently.
47
 
48
  ## Usage
49
 
50
  ```python
51
  from datasets import load_dataset
52
 
53
- # Load a specific GWAS (e.g., adhd2010)
54
  ds = load_dataset("OpenMed/pgc-adhd", "adhd2010")
55
  print(ds)
56
  ```
57
 
58
- ### Available Configs
59
 
60
  ```python
61
  from datasets import get_dataset_config_names
62
- configs = get_dataset_config_names("OpenMed/pgc-adhd")
63
- print(configs)
64
  ```
65
 
66
- ## Subsets (Publications)
67
 
68
- | Config | Phenotype | Journal | Year | PubMed | Rows | License |
69
- |--------|-----------|---------|------|--------|------|---------|
70
- | `adhd2010` | ADHD | JAACAP | 2010 | [20732625](https://pubmed.ncbi.nlm.nih.gov/20732625/) | — | CC BY 4.0 |
71
- | `adhd2018_SexSpecific` | ADHD (Sex-Specific) | Biological Psychiatry | 2018 | [29325848](https://pubmed.ncbi.nlm.nih.gov/29325848/) | 15,161,955 | CC BY 4.0 |
72
- | `adhd2019` | ADHD | Nature Genetics | 2019 | [30478444](https://pubmed.ncbi.nlm.nih.gov/30478444/) | 8,094,094 | CC BY 4.0 |
73
- | `adhd2022` | ADHD | Nature Genetics | 2022 | [36702997](https://pubmed.ncbi.nlm.nih.gov/36702997/) | — | CC BY 4.0 |
74
 
75
  ## Data Format
76
 
77
- All data has been converted to **Apache Parquet** format with shards of 10,000 rows. Common columns include:
78
 
79
  | Column | Description |
80
  |--------|-------------|
81
  | `SNP` / `ID` | SNP rsID or variant identifier |
82
  | `CHR` | Chromosome |
83
  | `BP` / `POS` | Base-pair position (typically GRCh37/hg19) |
84
- | `A1` / `ALT` | Effect allele |
85
- | `A2` / `REF` | Non-effect (reference) allele |
86
  | `OR` / `BETA` | Odds ratio or effect size |
87
  | `SE` | Standard error |
88
  | `P` | P-value |
89
- | `INFO` | Imputation quality score |
90
- | `FRQ` / `MAF` | Allele frequency |
91
  | `_source_file` | Original source filename |
92
 
93
- > **Note:** Column names vary between publications. The `_source_file` column tracks the original file each row came from.
94
 
95
  ## Citation
96
 
97
- When using any subset, please cite:
98
 
99
- 1. The **original publication** (see PubMed links above)
100
- 2. The **data DOI** from Figshare (see supplementary metadata)
101
- 3. **Acknowledge the PGC:**
102
- > "Data were obtained from the Psychiatric Genomics Consortium — https://pgc.unc.edu/"
103
 
104
  ## Terms of Use
105
 
106
- This dataset is released under the **[CC BY 4.0](https://creativecommons.org/licenses/by/4.0/)** license.
107
 
108
- By using PGC summary statistics you agree to:
109
-
110
- 1. Cite the original publication(s)
111
- 2. Not attempt to re-identify individual participants
112
- 3. Comply with the PGC's [data use policies](https://pgc.unc.edu/for-researchers/data-access/)
113
 
114
  ## Source
115
 
116
- - **Consortium:** [Psychiatric Genomics Consortium (PGC)](https://pgc.unc.edu/)
117
- - **PGC Downloads:** [pgc.unc.edu/for-researchers/download-results/](https://pgc.unc.edu/for-researchers/download-results/)
 
1
  ---
2
  license: cc-by-4.0
3
  task_categories:
4
+ - tabular-regression
5
+ - tabular-classification
6
  tags:
7
+ - gwas
8
+ - summary-statistics
9
+ - psychiatric-genomics
10
+ - pgc
11
+ - adhd
12
+ - mental-health
13
+ - genetics
14
+ - genomics
15
+ pretty_name: >-
16
+ PGC Attention Deficit Hyperactivity Disorder GWAS Summary Statistics
17
  size_categories:
18
+ - 1M-10M
19
  configs:
20
+ - config_name: adhd2010
21
+ default: true
22
+ data_files:
23
+ - split: train
24
+ path: data/adhd2010/*.parquet
25
+ - config_name: adhd2018_SexSpecific
26
+ data_files:
27
+ - split: train
28
+ path: data/adhd2018_SexSpecific/*.parquet
29
+ - config_name: adhd2019
30
+ data_files:
31
+ - split: train
32
+ path: data/adhd2019/*.parquet
33
+ - config_name: adhd2022
34
+ data_files:
35
+ - split: train
36
+ path: data/adhd2022/*.parquet
37
  ---
38
 
39
  # PGC Attention Deficit Hyperactivity Disorder — GWAS Summary Statistics
 
44
 
45
  Genome-wide association study (GWAS) summary statistics for **Attention Deficit Hyperactivity Disorder** phenotypes from the [Psychiatric Genomics Consortium (PGC)](https://pgc.unc.edu/).
46
 
47
+ Each publication is available as a separate subset (config) and can be loaded independently.
48
 
49
  ## Usage
50
 
51
  ```python
52
  from datasets import load_dataset
53
 
54
+ # Load a specific GWAS
55
  ds = load_dataset("OpenMed/pgc-adhd", "adhd2010")
56
  print(ds)
57
  ```
58
 
59
+ ### List all available subsets
60
 
61
  ```python
62
  from datasets import get_dataset_config_names
63
+ print(get_dataset_config_names("OpenMed/pgc-adhd"))
 
64
  ```
65
 
66
+ ## Subsets
67
 
68
+ | Config | Phenotype | Journal | Year | PubMed | Rows |
69
+ |--------|-----------|---------|------|--------|------|
70
+ | `adhd2010` | ADHD | JAACAP | 2010 | [20732625](https://pubmed.ncbi.nlm.nih.gov/20732625/) | — |
71
+ | `adhd2018_SexSpecific` | ADHD (Sex-Specific) | Biological Psychiatry | 2018 | [29325848](https://pubmed.ncbi.nlm.nih.gov/29325848/) | |
72
+ | `adhd2019` | ADHD | Nature Genetics | 2019 | [30478444](https://pubmed.ncbi.nlm.nih.gov/30478444/) | |
73
+ | `adhd2022` | ADHD | Nature Genetics | 2022 | [36702997](https://pubmed.ncbi.nlm.nih.gov/36702997/) | — |
74
 
75
  ## Data Format
76
 
77
+ All data is stored as **Apache Parquet** shards (10,000 rows each). Common columns:
78
 
79
  | Column | Description |
80
  |--------|-------------|
81
  | `SNP` / `ID` | SNP rsID or variant identifier |
82
  | `CHR` | Chromosome |
83
  | `BP` / `POS` | Base-pair position (typically GRCh37/hg19) |
84
+ | `A1` | Effect allele |
85
+ | `A2` | Non-effect allele |
86
  | `OR` / `BETA` | Odds ratio or effect size |
87
  | `SE` | Standard error |
88
  | `P` | P-value |
 
 
89
  | `_source_file` | Original source filename |
90
 
91
+ > Column names vary between publications. Check each subset's schema.
92
 
93
  ## Citation
94
 
95
+ Please cite the original publication (see PubMed links above) and acknowledge the PGC:
96
 
97
+ > Data were obtained from the Psychiatric Genomics Consortium — https://pgc.unc.edu/
 
 
 
98
 
99
  ## Terms of Use
100
 
101
+ Released under **[CC BY 4.0](https://creativecommons.org/licenses/by/4.0/)**.
102
 
103
+ - Cite the original publication(s)
104
+ - Do not attempt to re-identify individual participants
105
+ - Comply with the PGC [data use policies](https://pgc.unc.edu/for-researchers/data-access/)
 
 
106
 
107
  ## Source
108
 
109
+ - [Psychiatric Genomics Consortium (PGC)](https://pgc.unc.edu/)
110
+ - [PGC Downloads](https://pgc.unc.edu/for-researchers/download-results/)