129
|
1 <tool name="CollectRnaSeqMetrics" id="picard_CollectRnaSeqMetrics" version="1.106.0">
|
|
2 <description>Collect RNA-Seq Metrics</description>
|
|
3 <requirements><requirement type="package" version="1.106.0">picard</requirement></requirements>
|
|
4 <command interpreter="python">
|
|
5 picard_wrapper.py -i "${input_file}" -d "${html_file.files_path}" -t "${html_file}"
|
|
6 -n "${out_prefix}" --tmpdir "${__new_file_path__}" --assumesorted ${ASSUME_SORTED}
|
|
7 --refflat ${REF_FLAT}
|
|
8 #if $identify_ribosomal.opt == "yes"
|
|
9 --ribosomalintervals ${identify_ribosomal.RIBOSOMAL_INTERVALS}
|
|
10 #end if
|
|
11 --malevel "${malevel}"
|
|
12 --minlength ${MINIMUM_LENGTH}
|
|
13 --strandspecificity ${STRAND_SPECIFICITY}
|
|
14 --rrnafragmentpercentage ${RRNA_FRAGMENT_PERCENTAGE}
|
|
15 #for $i in $IGNORE_SEQUENCES
|
|
16 --ignoreseq "${i.IGNORE_SEQUENCE}"
|
|
17 #end for
|
|
18 -j "\$JAVA_JAR_PATH/CollectRnaSeqMetrics.jar"
|
|
19 </command>
|
|
20
|
|
21 <stdio>
|
|
22 <exit_code range="0" level="warning" description="Tool finished correctly" />
|
|
23 </stdio>
|
|
24
|
|
25 <inputs>
|
|
26 <param format="sam" name="input_file" type="data" label="Input SAM file." help="" />
|
|
27
|
|
28 <param format="data" name="REF_FLAT" type="data" label="Gene annotations in refFlat form. Format described here: http://genome.ucsc.edu/goldenPath/gbdDescriptionsOld.html#RefFlat Required." help="" />
|
|
29
|
|
30 <conditional name="identify_ribosomal">
|
|
31 <param name="opt" type="select" label="Identify ribosomal bases" help="If 'no' is selected, no bases will be identified as being ribosomal.">
|
|
32 <option value="no">no</option>
|
|
33 <option value="yes">yes</option>
|
|
34 </param>
|
|
35 <when value="no" />
|
|
36 <when value="yes">
|
|
37 <param format="data" name="RIBOSOMAL_INTERVALS" type="data" label="Location of rRNA sequences in genome, in interval_list format. If not specified no bases will be identified as being ribosomal. Format described here: http://picard.sourceforge.net/javadoc/net/sf/picard/util/IntervalList.html Default value: null." help="" />
|
|
38 </when>
|
|
39 </conditional>
|
|
40
|
|
41 <param name="STRAND_SPECIFICITY" type="select" label="For strand-specific library prep." help="For unpaired reads, use FIRST_READ_TRANSCRIPTION_STRAND if the reads are expected to be on the transcription strand. {NONE, FIRST_READ_TRANSCRIPTION_STRAND, SECOND_READ_TRANSCRIPTION_STRAND}">
|
|
42 <option value="NONE" selected="True">None</option>
|
|
43 <option value="FIRST_READ_TRANSCRIPTION_STRAND">FIRST_READ_TRANSCRIPTION_STRAND</option>
|
|
44 <option value="SECOND_READ_TRANSCRIPTION_STRAND">SECOND_READ_TRANSCRIPTION_STRAND</option>
|
|
45 </param>
|
|
46
|
|
47 <param name="MINIMUM_LENGTH" type="text" value="500" label="When calculating coverage based values (e.g. CV of coverage) only use transcripts of this length or greater." help="" />
|
|
48
|
|
49 <repeat name="IGNORE_SEQUENCES" title="Ignore Sequences">
|
|
50 <param name="IGNORE_SEQUENCE" label="Ignore Sequence" type="text" help="If a read maps to a sequence specified with this option, all the bases in the read are counted as ignored bases." />
|
|
51 </repeat>
|
|
52
|
|
53 <param name="RRNA_FRAGMENT_PERCENTAGE" type="text" value="0.8" label="This percentage of the length of a fragment must overlap one of the ribosomal intervals for a read or read pair by this must in order to be considered rRNA." help="" />
|
|
54
|
|
55 <param name="malevel" value="0" type="select" multiple="true" label="Metric Accumulation Level"
|
|
56 help="Level(s) at which metrics will be accumulated">
|
|
57 <option value="ALL_READS" selected="true">All reads (default)</option>
|
|
58 <option value="SAMPLE" default="true">Sample</option>
|
|
59 <option value="LIBRARY" default="true">Library</option>
|
|
60 <option value="READ_GROUP" default="true">Read group</option>
|
|
61 </param>
|
|
62
|
|
63 <param checked="True" truevalue="true" falsevalue="false" name="ASSUME_SORTED" type="boolean" label="If true (default), then the sort order in the header file will be ignored." />
|
|
64 </inputs>
|
|
65 <outputs>
|
|
66 <data format="html" name="html_file" label="${out_prefix}.html"/>
|
|
67 </outputs>
|
|
68 <tests>
|
|
69 <test>
|
|
70
|
|
71 </test>
|
|
72 </tests>
|
|
73 <help>
|
|
74 Picard documentation says:
|
|
75
|
|
76
|
|
77 CollectRnaSeqMetrics
|
|
78
|
|
79 Documentation: http://picard.sourceforge.net/command-line-overview.shtml#CollectRnaSeqMetrics
|
|
80 Program to collect metrics about the alignment of RNA to various functional classes of loci in the genome: coding, intronic, UTR, intergenic, ribosomal. Also determines strand-specificity for strand-specific libraries.
|
|
81 Option Description
|
|
82 REF_FLAT=File Gene annotations in refFlat form. Format described here: http://genome.ucsc.edu/goldenPath/gbdDescriptionsOld.html#RefFlat Required.
|
|
83 RIBOSOMAL_INTERVALS=File Location of rRNA sequences in genome, in interval_list format. If not specified no bases will be identified as being ribosomal. Format described here: http://picard.sourceforge.net/javadoc/net/sf/picard/util/IntervalList.html Default value: null.
|
|
84 STRAND_SPECIFICITY=StrandSpecificity For strand-specific library prep. For unpaired reads, use FIRST_READ_TRANSCRIPTION_STRAND if the reads are expected to be on the transcription strand. Required. Possible values: {NONE, FIRST_READ_TRANSCRIPTION_STRAND, SECOND_READ_TRANSCRIPTION_STRAND}
|
|
85 MINIMUM_LENGTH=Integer When calculating coverage based values (e.g. CV of coverage) only use transcripts of this length or greater. Default value: 500. This option can be set to 'null' to clear the default value.
|
|
86 CHART_OUTPUT=File The PDF file to write out a plot of normalized position vs. coverage. Default value: null.
|
|
87 IGNORE_SEQUENCE=String If a read maps to a sequence specified with this option, all the bases in the read are counted as ignored bases. These reads are not counted as This option may be specified 0 or more times.
|
|
88 RRNA_FRAGMENT_PERCENTAGE=Double This percentage of the length of a fragment must overlap one of the ribosomal intervals for a read or read pair by this must in order to be considered rRNA. Default value: 0.8. This option can be set to 'null' to clear the default value.
|
|
89 METRIC_ACCUMULATION_LEVEL=MetricAccumulationLevel The level(s) at which to accumulate metrics. Possible values: {ALL_READS, SAMPLE, LIBRARY, READ_GROUP} This option may be specified 0 or more times. This option can be set to 'null' to clear the default list.
|
|
90 INPUT=File Input SAM or BAM file. Required.
|
|
91 OUTPUT=File File to write the output to. Required.
|
|
92 REFERENCE_SEQUENCE=File Reference sequence fasta Default value: null.
|
|
93 ASSUME_SORTED=Boolean If true (default), then the sort order in the header file will be ignored. Default value: true. This option can be set to 'null' to clear the default value. Possible values: {true, false}
|
|
94 STOP_AFTER=Long Stop after processing N reads, mainly for debugging. Default value: 0. This option can be set to 'null' to clear the default value.
|
|
95
|
|
96
|
|
97 </help>
|
|
98 </tool>
|