-
Notifications
You must be signed in to change notification settings - Fork 2
/
data.R
641 lines (625 loc) · 39.4 KB
/
data.R
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
#' Subset of RDDs detected by JACUSA2 in HEK-293 untreated cells
#'
#' @docType data
#'
#' @usage data(rdd)
#'
#' @references
#' Piechotta, M.; Wyler, E.; Ohler, U.; Landthaler, M. & Dieterich, C.
#' JACUSA: site-specific identification of RNA editing events from replicate sequencing data
#' BMC Bioinformatics, Springer Nature, 2017 , 18
#'
#' A dataset containing a subset of RNA DNA differences (RDDs) identified by JACUSA2 in untreated HEK-293 cells.
#' The fields are as follows:
#' @format a tibble with 18 elements:
#' \itemize{
#' \item id: Character string representing a unique identifier - created from contig, start, [end], and strand.
#' \item contig: Character string representing the contig of the variant
#' \item start: Numeric position of variant (>=0)
#' \item end: Numeric corresponds to "start + 1"
#' \item name: Character string. Name of used method \emph{call-2}
#' \item score: Numeric value representing the test-statistc. Higher values indicate more divergent pileups
#' \item strand: Character representing strand information; "+", "-", or "."(no strand information available)
#' \item bases: Numeric tibble with representing counts for A, C, G, and T base calls.
#' \item cov: Numeric value indicating the read coverage for this site
#' \item backtrack1: Character - indicator if backtracking was used for condition 1.
#' \item backtrack2: Character - indicator if backtracking was used for condition 2.
#' \item backtrackP: Character - indicator if backtracking was used for condition pooled condition.
#' \item reset1: Character - indicator if default estimation was unstable with for condition 1.
#' \item reset2: Character - indicator if default estimation was unstable with for condition 2.
#' \item resetP: Character - indicator if default estimation was unstable with for pooled condition.
#' \item info: Character string separated with ";" provding additional data for this specific site. Empty field is equal to "*"
#' \item filter: ";"-separated character string showing feature filter information. Empty field is equal to "*"
#' \item ref: Character "A", "C", "G", "T", or "N" representing the reference base for this site - inverted when strand is "-".
#' }
"rdd"
#' Subset of RRDs detected by JACUSA2 in HEK-293 ADAR KD and untreated cells
#'
#' Data extrated from:
#' Piechotta, M.; Wyler, E.; Ohler, U.; Landthaler, M. & Dieterich, C.
#' JACUSA: site-specific identification of RNA editing events from replicate sequencing data
#' BMC Bioinformatics, Springer Nature, 2017 , 18
#'
#' @docType data
#'
#' @usage data(rrd)
#'
#' @references
#' Piechotta, M.; Wyler, E.; Ohler, U.; Landthaler, M. & Dieterich, C.
#' JACUSA: site-specific identification of RNA editing events from replicate sequencing data
#' BMC Bioinformatics, Springer Nature, 2017 , 18
#'
#' A dataset containing a subset of RNA RNA differences (RRDs) identified by JACUSA2 in ADAR KD and untreated HEK-293 cells.
#' The fields are as follows:
#' @format a tibble with 18 elements:
#' \itemize{
#' \item id: Character string representing a unique identifier - created from contig, start, [end], and strand.
#' \item contig: Character string representing the contig of the variant
#' \item start: Numeric position of variant (>=0)
#' \item end: Numeric corresponds to "start + 1"
#' \item name: Character string. Name of used method \emph{call-2}
#' \item score: Numeric value representing the test-statistc. Higher values indicate more divergent pileups
#' \item strand: Character representing strand information; "+", "-", or "."(no strand information available)
#' \item bases: Numeric tibble with representing counts for A, C, G, and T base calls.
#' \item cov: Numeric value indicating the read coverage for this site
#' \item backtrack1: Character - indicator if backtracking was used for condition 1.
#' \item backtrack2: Character - indicator if backtracking was used for condition 2.
#' \item backtrackP: Character - indicator if backtracking was used for condition pooled condition.
#' \item reset1: Character - indicator if default estimation was unstable with for condition 1.
#' \item reset2: Character - indicator if default estimation was unstable with for condition 2.
#' \item resetP: Character - indicator if default estimation was unstable with for pooled condition.
#' \item info: Character string separated with ";" provding additional data for this specific site. Empty field is equal to "*"
#' \item filter: ";"-separated character string showing feature filter information. Empty field is equal to "*"
#' \item ref: Character "A", "C", "G", "T", or "N" representing the reference base for this site - inverted when strand is "-".
#' }
"rrd"
#' JACUSA2 output for rt-arrest on HIVRT condition in Zhou et. al 2018 data
#'
#' Zhou2018 et al. 2018 map RNA modification of pseudouridine \eqn{\Psi} by chemically modifying
#' pseudouridines with carbodiimide (+CMC) and detecting arrest events that are induced by reverse
#' transcription stops in high-throughput sequencing under 3 different conditions (HIVRT, SIIIMn, and
#' SIIIMg).
#' Result are for running JACUSA2 rt-arrest on processed pairwise +CMC and -CMC(control) data in HIVRT condition are presented.
#'
#' Check Section "Reverse transcriptase arrest events" in
#' https://github.com/dieterich-lab/JACUSA2/blob/master/manual/manual.pdf
#' for details on pre-processing and mapping primary sequencing data.
#'
#' @docType data
#'
#' @usage data(HIVRT_rt_arrest)
#'
#' @references Zhou, K. I.; Clark, W. C.; Pan, D. W.; Eckwahl, M. J.; Dai, Q. & Pan, T.
#' Pseudouridines have context-dependent mutation and stop rates in high-throughput sequencing
#' RNA Biology, Informa UK Limited, 2018 , 15 , 892-900
#'
#' @format a tibble with 22 elements:
#' \itemize{
#' \item id: Character string representing a unique identifier - created from contig, start, [end], and strand.
#' \item contig: Character string representing the contig of the variant
#' \item start: Numeric position of variant (>=0)
#' \item end: Numeric corresponds to "start + 1"
#' \item name: Character string. Name of used method \emph{call-2}
#' \item pvalue: Numeric value representing the pvalue of the test.
#' \item strand: Character representing strand information; "+", "-", or "."(no strand information available)
#' \item arrest: Numeric tibble with representing counts for A, C, G, and T base calls from arrest reads.
#' \item through: Numeric tibble with representing counts for A, C, G, and T base calls from through reads.
#' \item bases: Numeric tibble with representing counts for A, C, G, and T base calls.
#' \item cov: Numeric value indicating the read coverage for this site
#' \item arrest_rate: Numeric tibble representing the arrest rate for each sample.
#' \item arrest_score: Numeric - test-statistic score.
#' \item backtrack1: Character - indicator if backtracking was used for condition 1.
#' \item backtrack2: Character - indicator if backtracking was used for condition 2.
#' \item backtrackP: Character - indicator if backtracking was used for condition pooled condition.
#' \item reset1: Character - indicator if default estimation was unstable with for condition 1.
#' \item reset2: Character - indicator if default estimation was unstable with for condition 2.
#' \item resetP: Character - indicator if default estimation was unstable with for pooled condition.
#' \item info: Character string separated with ";" provding additional data for this specific site. Empty field is equal to "*"
#' \item filter: ";"-separated character string showing feature filter information. Empty field is equal to "*"
#' \item ref: Character "A", "C", "G", "T", or "N" representing the reference base for this site - inverted when strand is "-".
#' }
"HIVRT_rt_arrest"
#' JACUSA2 output for rt-arrest on SIIIRTMg condition in Zhou et. al 2018 data
#'
#' Zhou2018 et al. 2018 map RNA modification of pseudouridine \eqn{\Psi} by chemically modifying
#' pseudouridines with carbodiimide (+CMC) and detecting arrest events that are induced by reverse
#' transcription stops in high-throughput sequencing under 3 different conditions (HIVRT, SIIIMn, and
#' SIIIMg).
#' Result are for running JACUSA2 rt-arrest on processed pairwise +CMC and -CMC(control) data in SIIIRTMg condition are presented.
#'
#' Check Section "Reverse transcriptase arrest events" in
#' https://github.com/dieterich-lab/JACUSA2/blob/master/manual/manual.pdf
#' for details on pre-processing and mapping primary sequencing data.
#'
#' @docType data
#'
#' @usage data(SIIIRTMg_rt_arrest)
#'
#' @references Zhou, K. I.; Clark, W. C.; Pan, D. W.; Eckwahl, M. J.; Dai, Q. & Pan, T.
#' Pseudouridines have context-dependent mutation and stop rates in high-throughput sequencing
#' RNA Biology, Informa UK Limited, 2018 , 15 , 892-900
#'
#' @format a tibble with 22 elements:
#' \itemize{
#' \item id: Character string representing a unique identifier - created from contig, start, [end], and strand.
#' \item contig: Character string representing the contig of the variant
#' \item start: Numeric position of variant (>=0)
#' \item end: Numeric corresponds to "start + 1"
#' \item name: Character string. Name of used method \emph{call-2}
#' \item pvalue: Numeric value representing the pvalue of the test.
#' \item strand: Character representing strand information; "+", "-", or "."(no strand information available)
#' \item arrest: Numeric tibble with representing counts for A, C, G, and T base calls from arrest reads.
#' \item through: Numeric tibble with representing counts for A, C, G, and T base calls from through reads.
#' \item bases: Numeric tibble with representing counts for A, C, G, and T base calls.
#' \item cov: Numeric value indicating the read coverage for this site
#' \item arrest_rate: Numeric tibble representing the arrest rate for each sample.
#' \item arrest_score: Numeric - test-statistic score.
#' \item backtrack1: Character - indicator if backtracking was used for condition 1.
#' \item backtrack2: Character - indicator if backtracking was used for condition 2.
#' \item backtrackP: Character - indicator if backtracking was used for condition pooled condition.
#' \item reset1: Character - indicator if default estimation was unstable with for condition 1.
#' \item reset2: Character - indicator if default estimation was unstable with for condition 2.
#' \item resetP: Character - indicator if default estimation was unstable with for pooled condition.
#' \item info: Character string separated with ";" provding additional data for this specific site. Empty field is equal to "*"
#' \item filter: ";"-separated character string showing feature filter information. Empty field is equal to "*"
#' \item ref: Character "A", "C", "G", "T", or "N" representing the reference base for this site - inverted when strand is "-".
#' }
"SIIIRTMg_rt_arrest"
#' JACUSA2 output for rt-arrest on SIIIRTMn condition in Zhou et. al 2018 data
#'
#' Zhou2018 et al. 2018 map RNA modification of pseudouridine \eqn{\Psi} by chemically modifying
#' pseudouridines with carbodiimide (+CMC) and detecting arrest events that are induced by reverse
#' transcription stops in high-throughput sequencing under 3 different conditions (HIVRT, SIIIMn, and
#' SIIIMg).
#' Result are for running JACUSA2 rt-arrest on processed pairwise +CMC and -CMC(control) data in SIIIRTMn condition are presented.
#'
#' Check Section "Reverse transcriptase arrest events"
#' https://github.com/dieterich-lab/JACUSA2/blob/master/manual/manual.pdf
#' for details on pre-processing and mapping primary sequencing data.
#'
#' @docType data
#'
#' @usage data(SIIIRTMn_rt_arrest)
#'
#' @references Zhou, K. I.; Clark, W. C.; Pan, D. W.; Eckwahl, M. J.; Dai, Q. & Pan, T.
#' Pseudouridines have context-dependent mutation and stop rates in high-throughput sequencing
#' RNA Biology, Informa UK Limited, 2018 , 15 , 892-900
#'
#' @format a tibble with 22 elements:
#' \itemize{
#' \item id: Character string representing a unique identifier - created from contig, start, [end], and strand.
#' \item contig: Character string representing the contig of the variant
#' \item start: Numeric position of variant (>=0)
#' \item end: Numeric corresponds to "start + 1"
#' \item name: Character string. Name of used method \emph{call-2}
#' \item pvalue: Numeric value representing the pvalue of the test.
#' \item strand: Character representing strand information; "+", "-", or "."(no strand information available)
#' \item arrest: Numeric tibble with representing counts for A, C, G, and T base calls from arrest reads.
#' \item through: Numeric tibble with representing counts for A, C, G, and T base calls from through reads.
#' \item bases: Numeric tibble with representing counts for A, C, G, and T base calls.
#' \item cov: Numeric value indicating the read coverage for this site
#' \item arrest_rate: Numeric tibble representing the arrest rate for each sample.
#' \item arrest_score: Numeric - test-statistic score.
#' \item backtrack1: Character - indicator if backtracking was used for condition 1.
#' \item backtrack2: Character - indicator if backtracking was used for condition 2.
#' \item backtrackP: Character - indicator if backtracking was used for condition pooled condition.
#' \item reset1: Character - indicator if default estimation was unstable with for condition 1.
#' \item reset2: Character - indicator if default estimation was unstable with for condition 2.
#' \item resetP: Character - indicator if default estimation was unstable with for pooled condition.
#' \item info: Character string separated with ";" provding additional data for this specific site. Empty field is equal to "*"
#' \item filter: ";"-separated character string showing feature filter information. Empty field is equal to "*"
#' \item ref: Character "A", "C", "G", "T", or "N" representing the reference base for this site - inverted when strand is "-".
#' }
"SIIIRTMn_rt_arrest"
#' Combined JACUSA2 output for rt-arrest on all conditions in Zhou et. al 2018 data
#'
#' Zhou2018 et al. 2018 map RNA modification of pseudouridine \eqn{\Psi} by chemically modifying
#' pseudouridines with carbodiimide (+CMC) and detecting arrest events that are induced by reverse
#' transcription stops in high-throughput sequencing under 3 different conditions (HIVRT, SIIIMn, and
#' SIIIMg).
#' A combined version of all conditions and their pairwise +CMC and -CMC(control) comparisons is presented.
#' The data structure contains an additional field "meta_condition" that corresponds and identifies the
#' condition from Zhou 2018:
#' \itemize{
#' \item HIVRT,
#' \item SIIIMn, and
#' \item SIIIMg.
#' }
#' This dataset exemplifies the usefullness of combining multiple pairwise comparisons and make them distinguishable by
#' "meta" field.
#'
#' Check Section "Reverse transcriptase arrest events" in
#' https://github.com/dieterich-lab/JACUSA2/blob/master/manual/manual.pdf
#' for details on pre-processing and mapping primary sequencing data.
#'
#' @docType data
#'
#' @usage data(Zhou2018_rt_arrest)
#'
#' @references Zhou, K. I.; Clark, W. C.; Pan, D. W.; Eckwahl, M. J.; Dai, Q. & Pan, T.
#' Pseudouridines have context-dependent mutation and stop rates in high-throughput sequencing
#' RNA Biology, Informa UK Limited, 2018 , 15 , 892-900
#'
#' @format a tibble with 23 elements:
#' \itemize{
#' \item id: Character string representing a unique identifier - created from contig, start, [end], and strand.
#' \item contig: Character string representing the contig of the variant
#' \item start: Numeric position of variant (>=0)
#' \item end: Numeric corresponds to "start + 1"
#' \item name: Character string. Name of used method \emph{call-2}
#' \item pvalue: Numeric value representing the pvalue of the test.
#' \item strand: Character representing strand information; "+", "-", or "."(no strand information available)
#' \item arrest: Numeric tibble with representing counts for A, C, G, and T base calls from arrest reads.
#' \item through: Numeric tibble with representing counts for A, C, G, and T base calls from through reads.
#' \item bases: Numeric tibble with representing counts for A, C, G, and T base calls.
#' \item cov: Numeric value indicating the read coverage for this site
#' \item arrest_rate: Numeric tibble representing the arrest rate for each sample.
#' \item arrest_score: Numeric - test-statistic score.
#' \item backtrack1: Character - indicator if backtracking was used for condition 1.
#' \item backtrack2: Character - indicator if backtracking was used for condition 2.
#' \item backtrackP: Character - indicator if backtracking was used for condition pooled condition.
#' \item reset1: Character - indicator if default estimation was unstable with for condition 1.
#' \item reset2: Character - indicator if default estimation was unstable with for condition 2.
#' \item resetP: Character - indicator if default estimation was unstable with for pooled condition.
#' \item info: Character string separated with ";" provding additional data for this specific site. Empty field is equal to "*"
#' \item filter: ";"-separated character string showing feature filter information. Empty field is equal to "*"
#' \item ref: Character "A", "C", "G", "T", or "N" representing the reference base for this site - inverted when strand is "-".
#' \item meta: Character string indicating the dataset. Here: "HIVRT", "SIIIRTMn", or "SIIIRTMn".
#' }
"Zhou2018_rt_arrest"
#' JACUSA2 output for call-2 on HIVRT condition in Zhou et. al 2018 data
#'
#' Zhou2018 et al. 2018 map RNA modification of pseudouridine \eqn{\Psi} by chemically modifying
#' pseudouridines with carbodiimide (+CMC) and detecting arrest events that are induced by reverse
#' transcription stops in high-throughput sequencing under 3 different conditions (HIVRT, SIIIMn, and
#' SIIIMg).
#' Result are for running JACUSA2 call-2 on processed pairwise +CMC and -CMC(control) data in HIVRT condition are presented.
#'
#' Check Section "Reverse transcriptase arrest events" in
#' https://github.com/dieterich-lab/JACUSA2/blob/master/manual/manual.pdf
#' for details on pre-processing and mapping primary sequencing data.
#'
#' @docType data
#'
#' @usage data(HIVRT_call2)
#'
#' @references Zhou, K. I.; Clark, W. C.; Pan, D. W.; Eckwahl, M. J.; Dai, Q. & Pan, T.
#' Pseudouridines have context-dependent mutation and stop rates in high-throughput sequencing
#' RNA Biology, Informa UK Limited, 2018 , 15 , 892-900
#'
#' @format a tibble with 18 elements:
#' \itemize{
#' \item id: Character string representing a unique identifier - created from contig, start, [end], and strand.
#' \item contig: Character string representing the contig of the variant
#' \item start: Numeric position of variant (>=0)
#' \item end: Numeric corresponds to "start + 1"
#' \item name: Character string. Name of used method \emph{call-2}
#' \item score: Numeric value representing the test-statistc. Higher values indicate more divergent pileups
#' \item strand: Character representing strand information; "+", "-", or "."(no strand information available)
#' \item bases: Numeric tibble with representing counts for A, C, G, and T base calls.
#' \item cov: Numeric value indicating the read coverage for this site
#' \item backtrack1: Character - indicator if backtracking was used for condition 1.
#' \item backtrack2: Character - indicator if backtracking was used for condition 2.
#' \item backtrackP: Character - indicator if backtracking was used for condition pooled condition.
#' \item reset1: Character - indicator if default estimation was unstable with for condition 1.
#' \item reset2: Character - indicator if default estimation was unstable with for condition 2.
#' \item resetP: Character - indicator if default estimation was unstable with for pooled condition.
#' \item info: Character string separated with ";" provding additional data for this specific site. Empty field is equal to "*"
#' \item filter: ";"-separated character string showing feature filter information. Empty field is equal to "*"
#' \item ref: Character "A", "C", "G", "T", or "N" representing the reference base for this site - inverted when strand is "-".
#' }
"HIVRT_call2"
#' JACUSA2 output for call-22 on SIIIRTMg condition in Zhou et. al 2018 data
#'
#' Zhou2018 et al. 2018 map RNA modification of pseudouridine \eqn{\Psi} by chemically modifying
#' pseudouridines with carbodiimide (+CMC) and detecting arrest events that are induced by reverse
#' transcription stops in high-throughput sequencing under 3 different conditions (HIVRT, SIIIMn, and
#' SIIIMg).
#' Result are for running JACUSA2 call-2 on processed pairwise +CMC and -CMC(control) data in SIIIRTMg condition are presented.
#'
#' Check Section "Reverse transcriptase arrest events"
#' https://github.com/dieterich-lab/JACUSA2/blob/master/manual/manual.pdf
#' for details on pre-processing and mapping primary sequencing data.
#'
#' @docType data
#'
#' @usage data(SIIIRTMg_call2)
#'
#' @references Zhou, K. I.; Clark, W. C.; Pan, D. W.; Eckwahl, M. J.; Dai, Q. & Pan, T.
#' Pseudouridines have context-dependent mutation and stop rates in high-throughput sequencing
#' RNA Biology, Informa UK Limited, 2018 , 15 , 892-900
#'
#' @format a tibble with 18 elements:
#' \itemize{
#' \item id: Character string representing a unique identifier - created from contig, start, [end], and strand.
#' \item contig: Character string representing the contig of the variant
#' \item start: Numeric position of variant (>=0)
#' \item end: Numeric corresponds to "start + 1"
#' \item name: Character string. Name of used method \emph{call-2}
#' \item score: Numeric value representing the test-statistc. Higher values indicate more divergent pileups
#' \item strand: Character representing strand information; "+", "-", or "."(no strand information available)
#' \item bases: Numeric tibble with representing counts for A, C, G, and T base calls.
#' \item cov: Numeric value indicating the read coverage for this site
#' \item backtrack1: Character - indicator if backtracking was used for condition 1.
#' \item backtrack2: Character - indicator if backtracking was used for condition 2.
#' \item backtrackP: Character - indicator if backtracking was used for condition pooled condition.
#' \item reset1: Character - indicator if default estimation was unstable with for condition 1.
#' \item reset2: Character - indicator if default estimation was unstable with for condition 2.
#' \item resetP: Character - indicator if default estimation was unstable with for pooled condition.
#' \item info: Character string separated with ";" provding additional data for this specific site. Empty field is equal to "*"
#' \item filter: ";"-separated character string showing feature filter information. Empty field is equal to "*"
#' \item ref: Character "A", "C", "G", "T", or "N" representing the reference base for this site - inverted when strand is "-".
#' }
"SIIIRTMg_call2"
#' JACUSA2 output for call-2 on SIIIRTMn condition in Zhou et. al 2018 data
#'
#' Zhou2018 et al. 2018 map RNA modification of pseudouridine \eqn{\Psi} by chemically modifying
#' pseudouridines with carbodiimide (+CMC) and detecting arrest events that are induced by reverse
#' transcription stops in high-throughput sequencing under 3 different conditions (HIVRT, SIIIMn, and
#' SIIIMg).
#' Result are for running JACUSA2 call-2 on processed pairwise +CMC and -CMC(control) data in SIIIRTMn condition are presented.
#'
#' Check Section "Reverse transcriptase arrest events" in
#' https://github.com/dieterich-lab/JACUSA2/blob/master/manual/manual.pdf
#' for details on pre-processing and mapping primary sequencing data.
#'
#' @docType data
#'
#' @usage data(SIIIRTMn_call2)
#'
#' @references Zhou, K. I.; Clark, W. C.; Pan, D. W.; Eckwahl, M. J.; Dai, Q. & Pan, T.
#' Pseudouridines have context-dependent mutation and stop rates in high-throughput sequencing
#' RNA Biology, Informa UK Limited, 2018 , 15 , 892-900
#'
#' @format a tibble with 18 elements:
#' \itemize{
#' \item id: Character string representing a unique identifier - created from contig, start, [end], and strand.
#' \item contig: Character string representing the contig of the variant
#' \item start: Numeric position of variant (>=0)
#' \item end: Numeric corresponds to "start + 1"
#' \item name: Character string. Name of used method \emph{call-2}
#' \item score: Numeric value representing the test-statistc. Higher values indicate more divergent pileups
#' \item strand: Character representing strand information; "+", "-", or "."(no strand information available)
#' \item bases: Numeric tibble with representing counts for A, C, G, and T base calls.
#' \item cov: Numeric value indicating the read coverage for this site
#' \item backtrack1: Character - indicator if backtracking was used for condition 1.
#' \item backtrack2: Character - indicator if backtracking was used for condition 2.
#' \item backtrackP: Character - indicator if backtracking was used for condition pooled condition.
#' \item reset1: Character - indicator if default estimation was unstable with for condition 1.
#' \item reset2: Character - indicator if default estimation was unstable with for condition 2.
#' \item resetP: Character - indicator if default estimation was unstable with for pooled condition.
#' \item info: Character string separated with ";" provding additional data for this specific site. Empty field is equal to "*"
#' \item filter: ";"-separated character string showing feature filter information. Empty field is equal to "*"
#' \item ref: Character "A", "C", "G", "T", or "N" representing the reference base for this site - inverted when strand is "-".
#' }
"SIIIRTMn_call2"
#' Combined JACUSA2 output for call-2 on all conditions in Zhou et. al 2018 data
#'
#' Zhou2018 et al. 2018 map RNA modification of pseudouridine \eqn{\Psi} by chemically modifying
#' pseudouridines with carbodiimide (+CMC) and detecting arrest events that are induced by reverse
#' transcription stops in high-throughput sequencing under 3 different conditions (HIVRT, SIIIMn, and
#' SIIIMg).
#' A combined version of all conditions and their pairwise +CMC and -CMC(control) comparisons is presented.
#' The data structure contains an additional field "meta_condition" that corresponds and identifies the
#' condition from Zhou 2018:
#' \itemize{
#' \item HIVRT,
#' \item SIIIMn, and
#' \item SIIIMg.
#' }
#' This dataset exemplifies the usefullness of combining multiple pairwise comparisons and make them distinguishable by
#' "meta" field.
#'
#' @docType data
#'
#' @usage data(Zhou2018_call2)
#'
#' @references Zhou, K. I.; Clark, W. C.; Pan, D. W.; Eckwahl, M. J.; Dai, Q. & Pan, T.
#' Pseudouridines have context-dependent mutation and stop rates in high-throughput sequencing
#' RNA Biology, Informa UK Limited, 2018 , 15 , 892-900
#'
#' @format a tibble with 19 elements:
#' \itemize{
#' \item id: Character string representing a unique identifier - created from contig, start, [end], and strand.
#' \item contig: Character string representing the contig of the variant
#' \item start: Numeric position of variant (>=0)
#' \item end: Numeric corresponds to "start + 1"
#' \item name: Character string. Name of used method \emph{call-2}
#' \item score: Numeric value representing the test-statistc. Higher values indicate more divergent pileups
#' \item strand: Character representing strand information; "+", "-", or "."(no strand information available)
#' \item bases: Numeric tibble with representing counts for A, C, G, and T base calls.
#' \item cov: Numeric value indicating the read coverage for this site
#' \item backtrack1: Character - indicator if backtracking was used for condition 1.
#' \item backtrack2: Character - indicator if backtracking was used for condition 2.
#' \item backtrackP: Character - indicator if backtracking was used for condition pooled condition.
#' \item reset1: Character - indicator if default estimation was unstable with for condition 1.
#' \item reset2: Character - indicator if default estimation was unstable with for condition 2.
#' \item resetP: Character - indicator if default estimation was unstable with for pooled condition.
#' \item info: Character string separated with ";" provding additional data for this specific site. Empty field is equal to "*"
#' \item filter: ";"-separated character string showing feature filter information. Empty field is equal to "*"
#' \item ref: Character "A", "C", "G", "T", or "N" representing the reference base for this site - inverted when strand is "-".
#' \item meta: Character string indicating the dataset. Here: "HIVRT", "SIIIRTMn", or "SIIIRTMn".
#' }
"Zhou2018_call2"
#' rRNA modification map of rRNAs according to Taika et al.
#'
#' Data (18S, 28S, and 5.8S) has been extracted from retrieved from PMID: 30202881.
#'
#' @docType data
#'
#' @usage data(rnam)
#'
#' @references Landscape of the complete RNA chemical modifications in the human 80S ribosome
#' Masato Taoka, Yuko Nobe, Yuka Yamaki, Ko Sato, Hideaki Ishikawa,
#' Keiichi Izumikawa, Yoshio Yamauchi, Kouji Hirota, Hiroshi Nakayama,
#' Nobuhiro Takahashi et al.
#' Nucleic Acids Research, Volume 46, Issue 18, 12 October 2018, Pages 9289–9298,
#' https://doi.org/10.1093/nar/gky811
#'
#' @format a data.frame with 3 elements:
#' \itemize{
#' \item rrna: String, either "18S", "28S", or "5.8S"
#' \item pos: Numeric 1-index position.
#' \item base: String, reference base(A, C, G, T) or modification(ac4C, AM, Cm,
#' Gm, m1A, m1acp3pusU, m3U, m5C, m62A, m6A, m7G, ND, psU, psUm, Um)
#' }
"rnam"
#' DART-seq from Meyer 2019
#'
#' A complementary genetic approach is an extension of the TRIBE technique called DART-seq Meyer 2019.
#' Beyer applied DART-seq on HEK293 cells where the APOBEC domain was fused to the YTH domain from human YTHDF2 (WT and mutated).
#' In essence, new C-to-U editing events that are significantly enriched in the YTHDF2-WT,
#' but not in the binding domain mutant are bona fide candidates for m6A RNA modification
#'
#' @docType data
#'
#' @usage data(DARTseq)
#'
#' @references Meyer, Kate D., Nature methods, December 19, 2019
#'
#' @format a tibble with 18 elements:
#' \itemize{
#' \item id: Character string representing a unique identifier - created from contig, start, [end], and strand.
#' \item contig: Character string representing the contig of the variant
#' \item start: Numeric position of variant (>=0)
#' \item end: Numeric corresponds to "start + 1"
#' \item name: Character string. Name of used method \emph{call-2}
#' \item score: Numeric value representing the test-statistc. Higher values indicate more divergent pileups
#' \item strand: Character representing strand information; "+", "-", or "."(no strand information available)
#' \item bases: Numeric tibble with representing counts for A, C, G, and T base calls.
#' \item cov: Numeric value indicating the read coverage for this site
#' \item backtrack1: Character - indicator if backtracking was used for condition 1.
#' \item backtrack2: Character - indicator if backtracking was used for condition 2.
#' \item backtrackP: Character - indicator if backtracking was used for condition pooled condition.
#' \item reset1: Character - indicator if default estimation was unstable with for condition 1.
#' \item reset2: Character - indicator if default estimation was unstable with for condition 2.
#' \item resetP: Character - indicator if default estimation was unstable with for pooled condition.
#' \item info: Character string separated with ";" provding additional data for this specific site. Empty field is equal to "*"
#' \item filter: ";"-separated character string showing feature filter information. Empty field is equal to "*"
#' \item ref: Character "A", "C", "G", "T", or "N" representing the reference base for this site - inverted when strand is "-".
#' }
"DARTseq"
#' MazF_FTO from Zhang et al. 2019
#'
#' In the following, the use of of the rt-arrest function will be applied to a MazF digestion assay from Zhang et al. 2019.
#' Herein, 3 replicates of HEK293 mRNA were treated with FTO or mock treated and then subjected to a MazF digestion assay.
#'
#' @docType data
#'
#' @usage data(MazF_FTO)
#'
#' @references Zhang, Zhang and Chen, Li-Qian and Zhao, Yu-Li and Yang,
#' Cai-Guang and Roundtree, Ian A. and Zhang, Zijie and Ren, Jian and
#' Xie, Wei and He, Chuan and Luo, Guan-Zheng
#' Science advances, July 5, 2019
#'
#'
#' @format a tibble with 22 elements:
#' \itemize{
#' \item id: Character string representing a unique identifier - created from contig, start, [end], and strand.
#' \item contig: Character string representing the contig of the variant
#' \item start: Numeric position of variant (>=0)
#' \item end: Numeric corresponds to "start + 1"
#' \item name: Character string. Name of used method \emph{call-2}
#' \item pvalue: Numeric value representing the pvalue of the test.
#' \item strand: Character representing strand information; "+", "-", or "."(no strand information available)
#' \item arrest: Numeric tibble with representing counts for A, C, G, and T base calls from arrest reads.
#' \item through: Numeric tibble with representing counts for A, C, G, and T base calls from through reads.
#' \item bases: Numeric tibble with representing counts for A, C, G, and T base calls.
#' \item cov: Numeric value indicating the read coverage for this site
#' \item arrest_rate: Numeric tibble representing the arrest rate for each sample.
#' \item arrest_score: Numeric - test-statistic score.
#' \item backtrack1: Character - indicator if backtracking was used for condition 1.
#' \item backtrack2: Character - indicator if backtracking was used for condition 2.
#' \item backtrackP: Character - indicator if backtracking was used for condition pooled condition.
#' \item reset1: Character - indicator if default estimation was unstable with for condition 1.
#' \item reset2: Character - indicator if default estimation was unstable with for condition 2.
#' \item resetP: Character - indicator if default estimation was unstable with for pooled condition.
#' \item info: Character string separated with ";" provding additional data for this specific site. Empty field is equal to "*"
#' \item filter: ";"-separated character string showing feature filter information. Empty field is equal to "*"
#' \item ref: Character "A", "C", "G", "T", or "N" representing the reference base for this site - inverted when strand is "-".
#' }
"MazF_FTO"
#' m6a predictions from 3 miCLIP experiments
#'
#' Genomic coordinates (excluding Y chromosome) for m6a sites from 3 experiments:
#' \itemize{
#' \item Boulias et al. 2019,
#' \item Koh et al. 2019, and
#' \item Koertel et al. 2021.
#' }
#'
#' @docType data
#'
#' @usage data(m6a_miclip)
#'
#' @references Koh CWQ, Goh YT, Goh WSS. Atlas of quantitative single-base-resolution n6-methyl-adenine methylomes. Nat Commun. 2019; 10:5636. https://doi.org/10.1038/s41467-019-13561-z.
#' @references Boulias K, Toczydłowska-Socha D, Hawley BR, Liberman N, Takashima K, Zaccara S, Guez T, Vasseur J-J, Debart F, Aravind L, Jaffrey SR, Greer EL. Identification of the m, javax.xml.bind.jaxbelement@3155288a, am methyltransferase pcif1 reveals the location and functions of m, javax.xml.bind.jaxbelement@72f29a24, am in the transcriptome. Mol Cell. 2019; 75:631–6438. https://doi.org/10.1016/j.molcel.2019.06.006.
#' @references Körtel N, Rücklé C, Zhou Y, Busch A, Hoch-Kraft P, Sutandy FXR, Haase J, Pradhan M, Musheev M, Ostareck D, Ostareck-Lederer A, Dieterich C, Hüttelmaier S, Niehrs C, Rausch O, Dominissini D, König J, Zarnack K. Deep and accurate detection of m6a RNA modifications using miclip2 and m6aboost machine learning. Nucleic Acids Res. 2021; 49:92. https://doi.org/10.1093/nar/gkab485.
#'
#' @format a GRanges object:
#' \itemize{
#' \item experiments: Character string. Possible values, all combinations of: Boulias, Koh, and Koertel
#' \item region ref: Character string. Coordinates, format: "chr:start-end:strand".
#' }
"m6a_miclip"
#' Non-negative matrix factorization on m6a predictions from 3 miCLIP experiments
#'
#' @seealso JACUSA2helper::m6a_miclip.
#'
#' Predictions are based on data from:
#' \itemize{
#' \item Boulias et al. 2019,
#' \item Koh et al. 2019, and
#' \item Koertel et al. 2021.
#' }
#'
#' @docType data
#'
#' @usage data(m6a_nmf_results)
#'
#' @details description of list items:
#' \itemize{
#' \item{"estim_r"}{Factorizations for `x`}
#' \item{"nmf_matrix"}{Factorization of `x` with `r` that maximizes `estim_r$measures$silhouette.consensus` and `estim_r$measures$cophenetic`}
#' \item{"chosen_rank"}{Optimal rank}
#' \item{"chosen_pattern"}{The pattern that has the highest score}
##' \item{"reduced_coef"}{Reduced coefficient matrix.}
#' }
#'
#' @references Koh CWQ, Goh YT, Goh WSS. Atlas of quantitative single-base-resolution n6-methyl-adenine methylomes. Nat Commun. 2019; 10:5636. https://doi.org/10.1038/s41467-019-13561-z.
#' @references Boulias K, Toczydłowska-Socha D, Hawley BR, Liberman N, Takashima K, Zaccara S, Guez T, Vasseur J-J, Debart F, Aravind L, Jaffrey SR, Greer EL. Identification of the m, javax.xml.bind.jaxbelement@3155288a, am methyltransferase pcif1 reveals the location and functions of m, javax.xml.bind.jaxbelement@72f29a24, am in the transcriptome. Mol Cell. 2019; 75:631–6438. https://doi.org/10.1016/j.molcel.2019.06.006.
#' @references Körtel N, Rücklé C, Zhou Y, Busch A, Hoch-Kraft P, Sutandy FXR, Haase J, Pradhan M, Musheev M, Ostareck D, Ostareck-Lederer A, Dieterich C, Hüttelmaier S, Niehrs C, Rausch O, Dominissini D, König J, Zarnack K. Deep and accurate detection of m6a RNA modifications using miclip2 and m6aboost machine learning. Nucleic Acids Res. 2021; 49:92. https://doi.org/10.1093/nar/gkab485.
#'
#' @format a list with results from NMF
"m6a_nmf_results"
#' Non-negative matrix factorization on m6a predictions from 3 miCLIP experiments
#'
#' @seealso JACUSA2helper::m6a_miclip.
#'
#' Predictions are based on data from:
#' \itemize{
#' \item Boulias et al. 2019,
#' \item Koh et al. 2019, and
#' \item Koertel et al. 2021.
#' }
#'
#' @docType data
#'
#' @usage data(m6a_nmf_results)
#'
#' @details description of list items:
#' \itemize{
#' \item{"estim_r"}{Factorizations for `x`}
#' \item{"nmf_matrix"}{Factorization of `x` with `r` that maximizes `estim_r$measures$silhouette.consensus` and `estim_r$measures$cophenetic`}
#' \item{"chosen_rank"}{Optimal rank}
#' \item{"chosen_pattern"}{The pattern that has the highest score}
##' \item{"reduced_coef"}{Reduced coefficient matrix.}
#' }
#'
#' @references Koh CWQ, Goh YT, Goh WSS. Atlas of quantitative single-base-resolution n6-methyl-adenine methylomes. Nat Commun. 2019; 10:5636. https://doi.org/10.1038/s41467-019-13561-z.
#' @references Boulias K, Toczydłowska-Socha D, Hawley BR, Liberman N, Takashima K, Zaccara S, Guez T, Vasseur J-J, Debart F, Aravind L, Jaffrey SR, Greer EL. Identification of the m, javax.xml.bind.jaxbelement@3155288a, am methyltransferase pcif1 reveals the location and functions of m, javax.xml.bind.jaxbelement@72f29a24, am in the transcriptome. Mol Cell. 2019; 75:631–6438. https://doi.org/10.1016/j.molcel.2019.06.006.
#' @references Körtel N, Rücklé C, Zhou Y, Busch A, Hoch-Kraft P, Sutandy FXR, Haase J, Pradhan M, Musheev M, Ostareck D, Ostareck-Lederer A, Dieterich C, Hüttelmaier S, Niehrs C, Rausch O, Dominissini D, König J, Zarnack K. Deep and accurate detection of m6a RNA modifications using miclip2 and m6aboost machine learning. Nucleic Acids Res. 2021; 49:92. https://doi.org/10.1093/nar/gkab485.
#'
#' @format a list with results from NMF
"m6a_nmf_reduced"