Chase Mateusiak commited on
Commit
78ec915
·
1 Parent(s): 0e35c0f

addressing typos in readme

Browse files
Files changed (2) hide show
  1. .gitignore +1 -0
  2. README.md +38 -3
.gitignore ADDED
@@ -0,0 +1 @@
 
 
1
+ deprecated/
README.md CHANGED
@@ -1,11 +1,13 @@
1
  ---
2
  license: mit
3
  tags:
4
- - transcription-factor
5
  - binding
6
  - chipexo
7
  - genomics
8
  - biology
 
 
9
  language:
10
  - en
11
  pretty_name: Rossi ChIP-exo 2021
@@ -75,9 +77,11 @@ features:
75
  - name: regulator_locus_tag
76
  dtype: string
77
  description: Systematic gene name (ORF identifier) of the transcription factor
 
78
  - name: regulator_symbol
79
  dtype: string
80
  description: Standard gene symbol of the transcription factor
 
81
 
82
  - applies_to:
83
  - macs_bp500
@@ -93,21 +97,25 @@ features:
93
  overlapped the promoter, in which case nearest_score, median_score and
94
  max_score are NA. A single peak may overlap more than one promoter and is
95
  counted in each.
 
96
  - name: nearest_score
97
  dtype: float64
98
  description: >-
99
  -log10(q-value) of the peak whose midpoint lies closest to the TSS-proximal
100
  edge of the promoter. NA where no qualifying peak overlapped the promoter.
 
101
  - name: median_score
102
  dtype: float64
103
  description: >-
104
  Median -log10(q-value) over the peaks overlapping this promoter. NA where no
105
  qualifying peak overlapped the promoter.
 
106
  - name: max_score
107
  dtype: float64
108
  description: >-
109
  Maximum -log10(q-value) over the peaks overlapping this promoter. NA where no
110
  qualifying peak overlapped the promoter. Equivalent to testing n_peaks > 0.
 
111
 
112
  - applies_to:
113
  - rossi_2021_af_replicates
@@ -146,12 +154,15 @@ features:
146
  - name: seqnames
147
  dtype: string
148
  description: Chromosome identifier (e.g., chrI, chrII, chrXVI)
 
149
  - name: start
150
  dtype: int64
151
  description: Promoter region start position (1-based coordinate)
 
152
  - name: end
153
  dtype: int64
154
  description: Promoter region end position (1-based, inclusive)
 
155
 
156
  - applies_to:
157
  - rossi_2021_af_replicates
@@ -228,9 +239,11 @@ features:
228
  - name: width
229
  dtype: int64
230
  description: Width of the promoter region
 
231
  - name: strand
232
  dtype: string
233
  description: Genomic strand of the promoter region (+ or -)
 
234
  - name: mindel_name
235
  dtype: string
236
  description: Name of the promoter region as defined in the Mindel promoters
@@ -257,19 +270,23 @@ features:
257
  yeastepigenome.org score. Where multiple peaks are within 500bp upstream of a target
258
  ORF, we take the median peak score. Replicates are then combined. When
259
  combining replicates, the median score across all replicates is taken.
 
260
  - name: n_peaks
261
  dtype: int32
262
  description: >-
263
  The number of peaks annotated to the same target. This is both within replicates and
264
  across (ie, there might be 3 peaks in 2 replicates for a total of 6 in this data)
 
265
  - name: max_distance
266
  dtype: float64
267
  description: >-
268
  The maximum distance a peak in the set (see n_peaks) is from the ORF
 
269
  - name: peak_n_replicates
270
  dtype: int32
271
  description: >-
272
  The number of replicates which have peaks for this target
 
273
 
274
  configs:
275
  - config_name: rossi_2021_metadata_replicate
@@ -309,6 +326,7 @@ configs:
309
  - name: sample_id
310
  dtype: int64
311
  description: Unique identifier combining regulator and replicates
 
312
  - name: multi_antibody
313
  dtype: bool
314
  description: TRUE if the set of replicates includes more than one type of antibody
@@ -330,6 +348,7 @@ configs:
330
  - name: accession
331
  dtype: string
332
  description: SRA run accession identifier for the control sample
 
333
  - name: yeastepigenome_id
334
  dtype: float64
335
  description: Sample identifier used by yeastepigenome.org
@@ -350,15 +369,19 @@ configs:
350
  - name: accession
351
  dtype: string
352
  description: GEO run accession identifier for the sample (partitioning column)
 
353
  - name: chr
354
  dtype: string
355
  description: Chromosome name (e.g., chrI, chrII, etc.)
 
356
  - name: pos
357
  dtype: int32
358
  description: "Genomic position of the 5' tag"
 
359
  - name: pileup
360
  dtype: int32
361
  description: "Depth of coverage (number of 5' tags) at this genomic position"
 
362
 
363
  - config_name: genome_map_control
364
  description: "ChIP-exo 5' tag coverage data for input/control samples, partitioned by sample accession"
@@ -375,15 +398,19 @@ configs:
375
  - name: accession
376
  dtype: string
377
  description: GEO run accession identifier for the sample (partitioning column)
 
378
  - name: chr
379
  dtype: string
380
  description: Chromosome name (e.g., chrI, chrII, etc.)
 
381
  - name: pos
382
  dtype: int32
383
  description: "Genomic position of the 5' tag"
 
384
  - name: pileup
385
  dtype: int32
386
  description: "Depth of coverage (number of 5' tags) at this genomic position"
 
387
 
388
  - config_name: yep_filtered_peaks
389
  description: "yeastepigenome.org peaks with the peaks overlapping blacklisted regions removed (see Rossi paper)"
@@ -399,15 +426,19 @@ configs:
399
  - name: chr
400
  dtype: string
401
  description: Chromosome name (e.g., chrI, chrII, etc.)
 
402
  - name: start
403
  dtype: float64
404
  description: 0-based start position of the peak region
 
405
  - name: end
406
  dtype: float64
407
  description: 0-based, half open end position of a single base resolution peak
 
408
  - name: score
409
  dtype: float64
410
  description: "Score assigned by ChExMix as reported by yeastepigenome.org"
 
411
 
412
  - config_name: macs_bp500
413
  description: >-
@@ -438,6 +469,7 @@ configs:
438
  - name: sample_id
439
  dtype: int64
440
  description: sample identifier. use with rossi_2021_metadata_sample
 
441
 
442
  - config_name: macs_intergenic
443
  description: >-
@@ -472,6 +504,7 @@ configs:
472
  - name: sample_id
473
  dtype: int64
474
  description: sample identifier. use with rossi_2021_metadata_sample
 
475
 
476
  - config_name: macs_kang
477
  description: >-
@@ -503,6 +536,7 @@ configs:
503
  - name: sample_id
504
  dtype: int64
505
  description: sample identifier. use with rossi_2021_metadata_sample
 
506
 
507
  - config_name: macs_mindel
508
  description: >-
@@ -534,6 +568,7 @@ configs:
534
  - name: sample_id
535
  dtype: int64
536
  description: sample identifier. use with rossi_2021_metadata_sample
 
537
 
538
  - config_name: rossi_2021_af_replicates
539
  description: ChIP-exo annotated features at biological replicate level with binding peaks and statistical significance metrics
@@ -756,8 +791,8 @@ print(info["citation"])
756
  # path to the downloaded brentlab_yeast_collection.yaml
757
  vdb = VirtualDB("/path/to/brentlab_yeast_collection.yaml")
758
 
759
- print(vdb.get_dataset_description("rossi"))
760
- vdb.query("SELECT * FROM rossi LIMIT 5")
761
  ```
762
 
763
  ### Direct parquet access
 
1
  ---
2
  license: mit
3
  tags:
4
+ - transcription-factors
5
  - binding
6
  - chipexo
7
  - genomics
8
  - biology
9
+ - yeast
10
+ - saccharomyces-cerevisiae
11
  language:
12
  - en
13
  pretty_name: Rossi ChIP-exo 2021
 
77
  - name: regulator_locus_tag
78
  dtype: string
79
  description: Systematic gene name (ORF identifier) of the transcription factor
80
+ role: regulator_identifier
81
  - name: regulator_symbol
82
  dtype: string
83
  description: Standard gene symbol of the transcription factor
84
+ role: regulator_identifier
85
 
86
  - applies_to:
87
  - macs_bp500
 
97
  overlapped the promoter, in which case nearest_score, median_score and
98
  max_score are NA. A single peak may overlap more than one promoter and is
99
  counted in each.
100
+ role: quantitative_measure
101
  - name: nearest_score
102
  dtype: float64
103
  description: >-
104
  -log10(q-value) of the peak whose midpoint lies closest to the TSS-proximal
105
  edge of the promoter. NA where no qualifying peak overlapped the promoter.
106
+ role: quantitative_measure
107
  - name: median_score
108
  dtype: float64
109
  description: >-
110
  Median -log10(q-value) over the peaks overlapping this promoter. NA where no
111
  qualifying peak overlapped the promoter.
112
+ role: quantitative_measure
113
  - name: max_score
114
  dtype: float64
115
  description: >-
116
  Maximum -log10(q-value) over the peaks overlapping this promoter. NA where no
117
  qualifying peak overlapped the promoter. Equivalent to testing n_peaks > 0.
118
+ role: quantitative_measure
119
 
120
  - applies_to:
121
  - rossi_2021_af_replicates
 
154
  - name: seqnames
155
  dtype: string
156
  description: Chromosome identifier (e.g., chrI, chrII, chrXVI)
157
+ role: coordinate
158
  - name: start
159
  dtype: int64
160
  description: Promoter region start position (1-based coordinate)
161
+ role: coordinate
162
  - name: end
163
  dtype: int64
164
  description: Promoter region end position (1-based, inclusive)
165
+ role: coordinate
166
 
167
  - applies_to:
168
  - rossi_2021_af_replicates
 
239
  - name: width
240
  dtype: int64
241
  description: Width of the promoter region
242
+ role: coordinate
243
  - name: strand
244
  dtype: string
245
  description: Genomic strand of the promoter region (+ or -)
246
+ role: coordinate
247
  - name: mindel_name
248
  dtype: string
249
  description: Name of the promoter region as defined in the Mindel promoters
 
270
  yeastepigenome.org score. Where multiple peaks are within 500bp upstream of a target
271
  ORF, we take the median peak score. Replicates are then combined. When
272
  combining replicates, the median score across all replicates is taken.
273
+ role: quantitative_measure
274
  - name: n_peaks
275
  dtype: int32
276
  description: >-
277
  The number of peaks annotated to the same target. This is both within replicates and
278
  across (ie, there might be 3 peaks in 2 replicates for a total of 6 in this data)
279
+ role: quantitative_measure
280
  - name: max_distance
281
  dtype: float64
282
  description: >-
283
  The maximum distance a peak in the set (see n_peaks) is from the ORF
284
+ role: quantitative_measure
285
  - name: peak_n_replicates
286
  dtype: int32
287
  description: >-
288
  The number of replicates which have peaks for this target
289
+ role: quantitative_measure
290
 
291
  configs:
292
  - config_name: rossi_2021_metadata_replicate
 
326
  - name: sample_id
327
  dtype: int64
328
  description: Unique identifier combining regulator and replicates
329
+ role: sample_id
330
  - name: multi_antibody
331
  dtype: bool
332
  description: TRUE if the set of replicates includes more than one type of antibody
 
348
  - name: accession
349
  dtype: string
350
  description: SRA run accession identifier for the control sample
351
+ role: sample_id
352
  - name: yeastepigenome_id
353
  dtype: float64
354
  description: Sample identifier used by yeastepigenome.org
 
369
  - name: accession
370
  dtype: string
371
  description: GEO run accession identifier for the sample (partitioning column)
372
+ role: sample_id
373
  - name: chr
374
  dtype: string
375
  description: Chromosome name (e.g., chrI, chrII, etc.)
376
+ role: coordinate
377
  - name: pos
378
  dtype: int32
379
  description: "Genomic position of the 5' tag"
380
+ role: coordinate
381
  - name: pileup
382
  dtype: int32
383
  description: "Depth of coverage (number of 5' tags) at this genomic position"
384
+ role: quantitative_measure
385
 
386
  - config_name: genome_map_control
387
  description: "ChIP-exo 5' tag coverage data for input/control samples, partitioned by sample accession"
 
398
  - name: accession
399
  dtype: string
400
  description: GEO run accession identifier for the sample (partitioning column)
401
+ role: sample_id
402
  - name: chr
403
  dtype: string
404
  description: Chromosome name (e.g., chrI, chrII, etc.)
405
+ role: coordinate
406
  - name: pos
407
  dtype: int32
408
  description: "Genomic position of the 5' tag"
409
+ role: coordinate
410
  - name: pileup
411
  dtype: int32
412
  description: "Depth of coverage (number of 5' tags) at this genomic position"
413
+ role: quantitative_measure
414
 
415
  - config_name: yep_filtered_peaks
416
  description: "yeastepigenome.org peaks with the peaks overlapping blacklisted regions removed (see Rossi paper)"
 
426
  - name: chr
427
  dtype: string
428
  description: Chromosome name (e.g., chrI, chrII, etc.)
429
+ role: coordinate
430
  - name: start
431
  dtype: float64
432
  description: 0-based start position of the peak region
433
+ role: coordinate
434
  - name: end
435
  dtype: float64
436
  description: 0-based, half open end position of a single base resolution peak
437
+ role: coordinate
438
  - name: score
439
  dtype: float64
440
  description: "Score assigned by ChExMix as reported by yeastepigenome.org"
441
+ role: quantitative_measure
442
 
443
  - config_name: macs_bp500
444
  description: >-
 
469
  - name: sample_id
470
  dtype: int64
471
  description: sample identifier. use with rossi_2021_metadata_sample
472
+ role: sample_id
473
 
474
  - config_name: macs_intergenic
475
  description: >-
 
504
  - name: sample_id
505
  dtype: int64
506
  description: sample identifier. use with rossi_2021_metadata_sample
507
+ role: sample_id
508
 
509
  - config_name: macs_kang
510
  description: >-
 
536
  - name: sample_id
537
  dtype: int64
538
  description: sample identifier. use with rossi_2021_metadata_sample
539
+ role: sample_id
540
 
541
  - config_name: macs_mindel
542
  description: >-
 
568
  - name: sample_id
569
  dtype: int64
570
  description: sample identifier. use with rossi_2021_metadata_sample
571
+ role: sample_id
572
 
573
  - config_name: rossi_2021_af_replicates
574
  description: ChIP-exo annotated features at biological replicate level with binding peaks and statistical significance metrics
 
791
  # path to the downloaded brentlab_yeast_collection.yaml
792
  vdb = VirtualDB("/path/to/brentlab_yeast_collection.yaml")
793
 
794
+ print(vdb.get_dataset_description("rossi_500bp"))
795
+ vdb.query("SELECT * FROM rossi_500bp LIMIT 5")
796
  ```
797
 
798
  ### Direct parquet access