annotate picard_CollectRnaSeqMetrics.xml @ 129:03ed36a962af draft

Uploaded
author devteam
date Wed, 26 Feb 2014 02:10:19 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
129
03ed36a962af Uploaded
devteam
parents:
diff changeset
1 <tool name="CollectRnaSeqMetrics" id="picard_CollectRnaSeqMetrics" version="1.106.0">
03ed36a962af Uploaded
devteam
parents:
diff changeset
2 <description>Collect RNA-Seq Metrics</description>
03ed36a962af Uploaded
devteam
parents:
diff changeset
3 <requirements><requirement type="package" version="1.106.0">picard</requirement></requirements>
03ed36a962af Uploaded
devteam
parents:
diff changeset
4 <command interpreter="python">
03ed36a962af Uploaded
devteam
parents:
diff changeset
5 picard_wrapper.py -i "${input_file}" -d "${html_file.files_path}" -t "${html_file}"
03ed36a962af Uploaded
devteam
parents:
diff changeset
6 -n "${out_prefix}" --tmpdir "${__new_file_path__}" --assumesorted ${ASSUME_SORTED}
03ed36a962af Uploaded
devteam
parents:
diff changeset
7 --refflat ${REF_FLAT}
03ed36a962af Uploaded
devteam
parents:
diff changeset
8 #if $identify_ribosomal.opt == "yes"
03ed36a962af Uploaded
devteam
parents:
diff changeset
9 --ribosomalintervals ${identify_ribosomal.RIBOSOMAL_INTERVALS}
03ed36a962af Uploaded
devteam
parents:
diff changeset
10 #end if
03ed36a962af Uploaded
devteam
parents:
diff changeset
11 --malevel "${malevel}"
03ed36a962af Uploaded
devteam
parents:
diff changeset
12 --minlength ${MINIMUM_LENGTH}
03ed36a962af Uploaded
devteam
parents:
diff changeset
13 --strandspecificity ${STRAND_SPECIFICITY}
03ed36a962af Uploaded
devteam
parents:
diff changeset
14 --rrnafragmentpercentage ${RRNA_FRAGMENT_PERCENTAGE}
03ed36a962af Uploaded
devteam
parents:
diff changeset
15 #for $i in $IGNORE_SEQUENCES
03ed36a962af Uploaded
devteam
parents:
diff changeset
16 --ignoreseq "${i.IGNORE_SEQUENCE}"
03ed36a962af Uploaded
devteam
parents:
diff changeset
17 #end for
03ed36a962af Uploaded
devteam
parents:
diff changeset
18 -j "\$JAVA_JAR_PATH/CollectRnaSeqMetrics.jar"
03ed36a962af Uploaded
devteam
parents:
diff changeset
19 </command>
03ed36a962af Uploaded
devteam
parents:
diff changeset
20
03ed36a962af Uploaded
devteam
parents:
diff changeset
21 <stdio>
03ed36a962af Uploaded
devteam
parents:
diff changeset
22 <exit_code range="0" level="warning" description="Tool finished correctly" />
03ed36a962af Uploaded
devteam
parents:
diff changeset
23 </stdio>
03ed36a962af Uploaded
devteam
parents:
diff changeset
24
03ed36a962af Uploaded
devteam
parents:
diff changeset
25 <inputs>
03ed36a962af Uploaded
devteam
parents:
diff changeset
26 <param format="sam" name="input_file" type="data" label="Input SAM file." help="" />
03ed36a962af Uploaded
devteam
parents:
diff changeset
27
03ed36a962af Uploaded
devteam
parents:
diff changeset
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="" />
03ed36a962af Uploaded
devteam
parents:
diff changeset
29
03ed36a962af Uploaded
devteam
parents:
diff changeset
30 <conditional name="identify_ribosomal">
03ed36a962af Uploaded
devteam
parents:
diff changeset
31 <param name="opt" type="select" label="Identify ribosomal bases" help="If 'no' is selected, no bases will be identified as being ribosomal.">
03ed36a962af Uploaded
devteam
parents:
diff changeset
32 <option value="no">no</option>
03ed36a962af Uploaded
devteam
parents:
diff changeset
33 <option value="yes">yes</option>
03ed36a962af Uploaded
devteam
parents:
diff changeset
34 </param>
03ed36a962af Uploaded
devteam
parents:
diff changeset
35 <when value="no" />
03ed36a962af Uploaded
devteam
parents:
diff changeset
36 <when value="yes">
03ed36a962af Uploaded
devteam
parents:
diff changeset
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="" />
03ed36a962af Uploaded
devteam
parents:
diff changeset
38 </when>
03ed36a962af Uploaded
devteam
parents:
diff changeset
39 </conditional>
03ed36a962af Uploaded
devteam
parents:
diff changeset
40
03ed36a962af Uploaded
devteam
parents:
diff changeset
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}">
03ed36a962af Uploaded
devteam
parents:
diff changeset
42 <option value="NONE" selected="True">None</option>
03ed36a962af Uploaded
devteam
parents:
diff changeset
43 <option value="FIRST_READ_TRANSCRIPTION_STRAND">FIRST_READ_TRANSCRIPTION_STRAND</option>
03ed36a962af Uploaded
devteam
parents:
diff changeset
44 <option value="SECOND_READ_TRANSCRIPTION_STRAND">SECOND_READ_TRANSCRIPTION_STRAND</option>
03ed36a962af Uploaded
devteam
parents:
diff changeset
45 </param>
03ed36a962af Uploaded
devteam
parents:
diff changeset
46
03ed36a962af Uploaded
devteam
parents:
diff changeset
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="" />
03ed36a962af Uploaded
devteam
parents:
diff changeset
48
03ed36a962af Uploaded
devteam
parents:
diff changeset
49 <repeat name="IGNORE_SEQUENCES" title="Ignore Sequences">
03ed36a962af Uploaded
devteam
parents:
diff changeset
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." />
03ed36a962af Uploaded
devteam
parents:
diff changeset
51 </repeat>
03ed36a962af Uploaded
devteam
parents:
diff changeset
52
03ed36a962af Uploaded
devteam
parents:
diff changeset
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="" />
03ed36a962af Uploaded
devteam
parents:
diff changeset
54
03ed36a962af Uploaded
devteam
parents:
diff changeset
55 <param name="malevel" value="0" type="select" multiple="true" label="Metric Accumulation Level"
03ed36a962af Uploaded
devteam
parents:
diff changeset
56 help="Level(s) at which metrics will be accumulated">
03ed36a962af Uploaded
devteam
parents:
diff changeset
57 <option value="ALL_READS" selected="true">All reads (default)</option>
03ed36a962af Uploaded
devteam
parents:
diff changeset
58 <option value="SAMPLE" default="true">Sample</option>
03ed36a962af Uploaded
devteam
parents:
diff changeset
59 <option value="LIBRARY" default="true">Library</option>
03ed36a962af Uploaded
devteam
parents:
diff changeset
60 <option value="READ_GROUP" default="true">Read group</option>
03ed36a962af Uploaded
devteam
parents:
diff changeset
61 </param>
03ed36a962af Uploaded
devteam
parents:
diff changeset
62
03ed36a962af Uploaded
devteam
parents:
diff changeset
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." />
03ed36a962af Uploaded
devteam
parents:
diff changeset
64 </inputs>
03ed36a962af Uploaded
devteam
parents:
diff changeset
65 <outputs>
03ed36a962af Uploaded
devteam
parents:
diff changeset
66 <data format="html" name="html_file" label="${out_prefix}.html"/>
03ed36a962af Uploaded
devteam
parents:
diff changeset
67 </outputs>
03ed36a962af Uploaded
devteam
parents:
diff changeset
68 <tests>
03ed36a962af Uploaded
devteam
parents:
diff changeset
69 <test>
03ed36a962af Uploaded
devteam
parents:
diff changeset
70
03ed36a962af Uploaded
devteam
parents:
diff changeset
71 </test>
03ed36a962af Uploaded
devteam
parents:
diff changeset
72 </tests>
03ed36a962af Uploaded
devteam
parents:
diff changeset
73 <help>
03ed36a962af Uploaded
devteam
parents:
diff changeset
74 Picard documentation says:
03ed36a962af Uploaded
devteam
parents:
diff changeset
75
03ed36a962af Uploaded
devteam
parents:
diff changeset
76
03ed36a962af Uploaded
devteam
parents:
diff changeset
77 CollectRnaSeqMetrics
03ed36a962af Uploaded
devteam
parents:
diff changeset
78
03ed36a962af Uploaded
devteam
parents:
diff changeset
79 Documentation: http://picard.sourceforge.net/command-line-overview.shtml#CollectRnaSeqMetrics
03ed36a962af Uploaded
devteam
parents:
diff changeset
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.
03ed36a962af Uploaded
devteam
parents:
diff changeset
81 Option Description
03ed36a962af Uploaded
devteam
parents:
diff changeset
82 REF_FLAT=File Gene annotations in refFlat form. Format described here: http://genome.ucsc.edu/goldenPath/gbdDescriptionsOld.html#RefFlat Required.
03ed36a962af Uploaded
devteam
parents:
diff changeset
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.
03ed36a962af Uploaded
devteam
parents:
diff changeset
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}
03ed36a962af Uploaded
devteam
parents:
diff changeset
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.
03ed36a962af Uploaded
devteam
parents:
diff changeset
86 CHART_OUTPUT=File The PDF file to write out a plot of normalized position vs. coverage. Default value: null.
03ed36a962af Uploaded
devteam
parents:
diff changeset
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.
03ed36a962af Uploaded
devteam
parents:
diff changeset
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.
03ed36a962af Uploaded
devteam
parents:
diff changeset
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.
03ed36a962af Uploaded
devteam
parents:
diff changeset
90 INPUT=File Input SAM or BAM file. Required.
03ed36a962af Uploaded
devteam
parents:
diff changeset
91 OUTPUT=File File to write the output to. Required.
03ed36a962af Uploaded
devteam
parents:
diff changeset
92 REFERENCE_SEQUENCE=File Reference sequence fasta Default value: null.
03ed36a962af Uploaded
devteam
parents:
diff changeset
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}
03ed36a962af Uploaded
devteam
parents:
diff changeset
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.
03ed36a962af Uploaded
devteam
parents:
diff changeset
95
03ed36a962af Uploaded
devteam
parents:
diff changeset
96
03ed36a962af Uploaded
devteam
parents:
diff changeset
97 </help>
03ed36a962af Uploaded
devteam
parents:
diff changeset
98 </tool>