From 9050a2747b7948ae6c0d48fd1c0364a4031112bc Mon Sep 17 00:00:00 2001 From: sooheelee Date: Tue, 2 May 2017 18:10:49 -0400 Subject: [PATCH 1/3] Provide example REFFLAT file link and snippet Updated documentation to be more useful to users. This change addresses #804 at https://github.com/broadinstitute/picard/issues/804. --- src/main/java/picard/analysis/CollectRnaSeqMetrics.java | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/src/main/java/picard/analysis/CollectRnaSeqMetrics.java b/src/main/java/picard/analysis/CollectRnaSeqMetrics.java index aed80f0bf..39f15a874 100644 --- a/src/main/java/picard/analysis/CollectRnaSeqMetrics.java +++ b/src/main/java/picard/analysis/CollectRnaSeqMetrics.java @@ -72,9 +72,17 @@ "

The sequence input must be a valid SAM/BAM file containing RNAseq data aligned by an RNAseq-aware genome aligner such a "+ "STAR or TopHat. "+ "The tool also requires a REF_FLAT file, a tab-delimited file containing information about the location of RNA transcripts, "+ -"exon start and stop sites, etc. For more information on the REF_FLAT format, see the following "+ -"description. "+ -"Build-specific REF_FLAT files can be obtained here.

"+ +"exon start and stop sites, etc. For an example refFlat file for GRCh38, see refFlat.txt.gz at "+ +"http://hgdownload.cse.ucsc.edu/goldenPath/hg38/database. "+ +"The first five lines of the tab-limited text file appear as follows.

"+ + +"
" +
+"DDX11L1	NR_046018	chr1	+	11873	14409	14409	14409	3	11873,12612,13220,	12227,12721,14409,
" + +"WASH7P NR_024540 chr1 - 14361 29370 29370 29370 11 14361,14969,15795,16606,16857,17232,17605,17914,18267,24737,29320, 14829,15038,15947,16765,17055,17368,17742,18061,18366,24891,29370,
" + +"DLGAP2-AS1 NR_103863 chr8_KI270926v1_alt - 33083 35050 35050 35050 3 33083,33761,35028, 33281,33899,35050,
" + +"MIR570 NR_030296 chr3 + 195699400 195699497 195699497 195699497 1 195699400, 195699497,
" + +"MIR548A3 NR_030330 chr8 - 104484368 104484465 104484465 104484465 1 104484368, 104484465, + +"
" + ""+ "

Usage example:

"+ From ea0d1bbabcbe4f7f476b05904f05342ef7fd81f4 Mon Sep 17 00:00:00 2001 From: sooheelee Date: Tue, 2 May 2017 19:27:19 -0400 Subject: [PATCH 2/3] Update CollectRnaSeqMetrics.java --- src/main/java/picard/analysis/CollectRnaSeqMetrics.java | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/src/main/java/picard/analysis/CollectRnaSeqMetrics.java b/src/main/java/picard/analysis/CollectRnaSeqMetrics.java index 39f15a874..9f16b21cc 100644 --- a/src/main/java/picard/analysis/CollectRnaSeqMetrics.java +++ b/src/main/java/picard/analysis/CollectRnaSeqMetrics.java @@ -77,11 +77,11 @@ "The first five lines of the tab-limited text file appear as follows.

"+ "
" +
-"DDX11L1	NR_046018	chr1	+	11873	14409	14409	14409	3	11873,12612,13220,	12227,12721,14409,
" + -"WASH7P NR_024540 chr1 - 14361 29370 29370 29370 11 14361,14969,15795,16606,16857,17232,17605,17914,18267,24737,29320, 14829,15038,15947,16765,17055,17368,17742,18061,18366,24891,29370,
" + -"DLGAP2-AS1 NR_103863 chr8_KI270926v1_alt - 33083 35050 35050 35050 3 33083,33761,35028, 33281,33899,35050,
" + -"MIR570 NR_030296 chr3 + 195699400 195699497 195699497 195699497 1 195699400, 195699497,
" + -"MIR548A3 NR_030330 chr8 - 104484368 104484465 104484465 104484465 1 104484368, 104484465, + +"DDX11L1 NR_046018 chr1 + 11873 14409 14409 14409 3 11873,12612,13220, 12227,12721,14409," + +"WASH7P NR_024540 chr1 - 14361 29370 29370 29370 11 14361,14969,15795,16606,16857,17232,17605,17914,18267,24737,29320, 14829,15038,15947,16765,17055,17368,17742,18061,18366,24891,29370," + +"DLGAP2-AS1 NR_103863 chr8_KI270926v1_alt - 33083 35050 35050 35050 3 33083,33761,35028, 33281,33899,35050," + +"MIR570 NR_030296 chr3 + 195699400 195699497 195699497 195699497 1 195699400, 195699497," + +"MIR548A3 NR_030330 chr8 - 104484368 104484465 104484465 104484465 1 104484368, 104484465," + "
" + ""+ From 5549f87e3e7b1061df690647ef2a15c3751d0183 Mon Sep 17 00:00:00 2001 From: sooheelee Date: Tue, 2 May 2017 19:46:03 -0400 Subject: [PATCH 3/3] Added in missing bracket for unrelated portion of doc Note --- src/main/java/picard/analysis/CollectRnaSeqMetrics.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/main/java/picard/analysis/CollectRnaSeqMetrics.java b/src/main/java/picard/analysis/CollectRnaSeqMetrics.java index 9f16b21cc..a46e1cd6a 100644 --- a/src/main/java/picard/analysis/CollectRnaSeqMetrics.java +++ b/src/main/java/picard/analysis/CollectRnaSeqMetrics.java @@ -84,7 +84,7 @@ "MIR548A3 NR_030330 chr8 - 104484368 104484465 104484465 104484465 1 104484368, 104484465," + "" + -""+ +"

Note: Metrics labeled as percentages are actually expressed as fractions!

"+ "

Usage example:

"+ "
" +
 "java -jar picard.jar CollectRnaSeqMetrics \\
" +