annotate picard_CollectRnaSeqMetrics.xml @ 149:1f83354245da draft

Uploaded
author rayan
date Mon, 21 Jul 2014 16:17:32 -0400
parents 844fa42ad305
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
142
844fa42ad305 Uploaded
devteam
parents:
diff changeset
1 <tool name="CollectRnaSeqMetrics" id="picard_CollectRnaSeqMetrics" version="1.106.0">
844fa42ad305 Uploaded
devteam
parents:
diff changeset
2 <description>Collect RNA-Seq Metrics</description>
844fa42ad305 Uploaded
devteam
parents:
diff changeset
3 <requirements><requirement type="package" version="1.106.0">picard</requirement></requirements>
844fa42ad305 Uploaded
devteam
parents:
diff changeset
4 <command interpreter="python">
844fa42ad305 Uploaded
devteam
parents:
diff changeset
5 picard_wrapper.py -i "${input_file}" -d "${html_file.files_path}" -t "${html_file}"
844fa42ad305 Uploaded
devteam
parents:
diff changeset
6 -n "${out_prefix}" --tmpdir "${__new_file_path__}" --assumesorted ${ASSUME_SORTED}
844fa42ad305 Uploaded
devteam
parents:
diff changeset
7 --refflat ${REF_FLAT}
844fa42ad305 Uploaded
devteam
parents:
diff changeset
8 #if $identify_ribosomal.opt == "yes"
844fa42ad305 Uploaded
devteam
parents:
diff changeset
9 --ribosomalintervals ${identify_ribosomal.RIBOSOMAL_INTERVALS}
844fa42ad305 Uploaded
devteam
parents:
diff changeset
10 #end if
844fa42ad305 Uploaded
devteam
parents:
diff changeset
11 --malevel "${malevel}"
844fa42ad305 Uploaded
devteam
parents:
diff changeset
12 --minlength ${MINIMUM_LENGTH}
844fa42ad305 Uploaded
devteam
parents:
diff changeset
13 --strandspecificity ${STRAND_SPECIFICITY}
844fa42ad305 Uploaded
devteam
parents:
diff changeset
14 --rrnafragmentpercentage ${RRNA_FRAGMENT_PERCENTAGE}
844fa42ad305 Uploaded
devteam
parents:
diff changeset
15 #for $i in $IGNORE_SEQUENCES
844fa42ad305 Uploaded
devteam
parents:
diff changeset
16 --ignoreseq "${i.IGNORE_SEQUENCE}"
844fa42ad305 Uploaded
devteam
parents:
diff changeset
17 #end for
844fa42ad305 Uploaded
devteam
parents:
diff changeset
18 -j "\$JAVA_JAR_PATH/CollectRnaSeqMetrics.jar"
844fa42ad305 Uploaded
devteam
parents:
diff changeset
19 </command>
844fa42ad305 Uploaded
devteam
parents:
diff changeset
20
844fa42ad305 Uploaded
devteam
parents:
diff changeset
21 <stdio>
844fa42ad305 Uploaded
devteam
parents:
diff changeset
22 <exit_code range="0" level="warning" description="Tool finished correctly" />
844fa42ad305 Uploaded
devteam
parents:
diff changeset
23 </stdio>
844fa42ad305 Uploaded
devteam
parents:
diff changeset
24
844fa42ad305 Uploaded
devteam
parents:
diff changeset
25 <inputs>
844fa42ad305 Uploaded
devteam
parents:
diff changeset
26 <param format="sam" name="input_file" type="data" label="Input SAM file." help="" />
844fa42ad305 Uploaded
devteam
parents:
diff changeset
27 <param name="out_prefix" value="RNA-Seq Metrics" type="text"
844fa42ad305 Uploaded
devteam
parents:
diff changeset
28 label="Title for the output file" help="Use this remind you what the job was for." size="80" />
844fa42ad305 Uploaded
devteam
parents:
diff changeset
29
844fa42ad305 Uploaded
devteam
parents:
diff changeset
30 <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="" />
844fa42ad305 Uploaded
devteam
parents:
diff changeset
31
844fa42ad305 Uploaded
devteam
parents:
diff changeset
32 <conditional name="identify_ribosomal">
844fa42ad305 Uploaded
devteam
parents:
diff changeset
33 <param name="opt" type="select" label="Identify ribosomal bases" help="If 'no' is selected, no bases will be identified as being ribosomal.">
844fa42ad305 Uploaded
devteam
parents:
diff changeset
34 <option value="no">no</option>
844fa42ad305 Uploaded
devteam
parents:
diff changeset
35 <option value="yes">yes</option>
844fa42ad305 Uploaded
devteam
parents:
diff changeset
36 </param>
844fa42ad305 Uploaded
devteam
parents:
diff changeset
37 <when value="no" />
844fa42ad305 Uploaded
devteam
parents:
diff changeset
38 <when value="yes">
844fa42ad305 Uploaded
devteam
parents:
diff changeset
39 <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="" />
844fa42ad305 Uploaded
devteam
parents:
diff changeset
40 </when>
844fa42ad305 Uploaded
devteam
parents:
diff changeset
41 </conditional>
844fa42ad305 Uploaded
devteam
parents:
diff changeset
42
844fa42ad305 Uploaded
devteam
parents:
diff changeset
43 <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.">
844fa42ad305 Uploaded
devteam
parents:
diff changeset
44 <option value="NONE" selected="True">None</option>
844fa42ad305 Uploaded
devteam
parents:
diff changeset
45 <option value="FIRST_READ_TRANSCRIPTION_STRAND">FIRST_READ_TRANSCRIPTION_STRAND</option>
844fa42ad305 Uploaded
devteam
parents:
diff changeset
46 <option value="SECOND_READ_TRANSCRIPTION_STRAND">SECOND_READ_TRANSCRIPTION_STRAND</option>
844fa42ad305 Uploaded
devteam
parents:
diff changeset
47 </param>
844fa42ad305 Uploaded
devteam
parents:
diff changeset
48
844fa42ad305 Uploaded
devteam
parents:
diff changeset
49 <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="" />
844fa42ad305 Uploaded
devteam
parents:
diff changeset
50
844fa42ad305 Uploaded
devteam
parents:
diff changeset
51 <repeat name="IGNORE_SEQUENCES" title="Ignore Sequences">
844fa42ad305 Uploaded
devteam
parents:
diff changeset
52 <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." />
844fa42ad305 Uploaded
devteam
parents:
diff changeset
53 </repeat>
844fa42ad305 Uploaded
devteam
parents:
diff changeset
54
844fa42ad305 Uploaded
devteam
parents:
diff changeset
55 <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="" />
844fa42ad305 Uploaded
devteam
parents:
diff changeset
56
844fa42ad305 Uploaded
devteam
parents:
diff changeset
57 <param name="malevel" value="0" type="select" multiple="true" label="Metric Accumulation Level"
844fa42ad305 Uploaded
devteam
parents:
diff changeset
58 help="Level(s) at which metrics will be accumulated">
844fa42ad305 Uploaded
devteam
parents:
diff changeset
59 <option value="ALL_READS" selected="true">All reads (default)</option>
844fa42ad305 Uploaded
devteam
parents:
diff changeset
60 <option value="SAMPLE" default="true">Sample</option>
844fa42ad305 Uploaded
devteam
parents:
diff changeset
61 <option value="LIBRARY" default="true">Library</option>
844fa42ad305 Uploaded
devteam
parents:
diff changeset
62 <option value="READ_GROUP" default="true">Read group</option>
844fa42ad305 Uploaded
devteam
parents:
diff changeset
63 </param>
844fa42ad305 Uploaded
devteam
parents:
diff changeset
64
844fa42ad305 Uploaded
devteam
parents:
diff changeset
65 <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." />
844fa42ad305 Uploaded
devteam
parents:
diff changeset
66 </inputs>
844fa42ad305 Uploaded
devteam
parents:
diff changeset
67 <outputs>
844fa42ad305 Uploaded
devteam
parents:
diff changeset
68 <data format="html" name="html_file" label="${out_prefix}.html"/>
844fa42ad305 Uploaded
devteam
parents:
diff changeset
69 </outputs>
844fa42ad305 Uploaded
devteam
parents:
diff changeset
70 <tests>
844fa42ad305 Uploaded
devteam
parents:
diff changeset
71 <test>
844fa42ad305 Uploaded
devteam
parents:
diff changeset
72 <!-- python picard_wrapper.py
844fa42ad305 Uploaded
devteam
parents:
diff changeset
73 -i "/home/~/PICARD-in.sam"
844fa42ad305 Uploaded
devteam
parents:
diff changeset
74 -d "/home/~/outputrnaseqùetrics_files"
844fa42ad305 Uploaded
devteam
parents:
diff changeset
75 -t "/home/~/outputrnaseqmetrics.htm"
844fa42ad305 Uploaded
devteam
parents:
diff changeset
76 -n "RNA-Seq Metrics"
844fa42ad305 Uploaded
devteam
parents:
diff changeset
77 --tmpdir "/home/dorine/galaxypicard/galaxy-central/database/tmp"
844fa42ad305 Uploaded
devteam
parents:
diff changeset
78 --assumesorted true
844fa42ad305 Uploaded
devteam
parents:
diff changeset
79 --refflat /home/~/refFlat.txt --malevel "ALL_READS" --minlength 500 --strandspecificity NONE
844fa42ad305 Uploaded
devteam
parents:
diff changeset
80 --rrnafragmentpercentage 0.8 -j "/home/~/CollectRnaSeqMetrics.jar" -->
844fa42ad305 Uploaded
devteam
parents:
diff changeset
81 <param name="inputFile" value="PICARD-in.sam" />
844fa42ad305 Uploaded
devteam
parents:
diff changeset
82 <param name="out_prefix" value="RNA-Seq Metrics" />
844fa42ad305 Uploaded
devteam
parents:
diff changeset
83 <param name="ASSUME_SORTED" value="true" />
844fa42ad305 Uploaded
devteam
parents:
diff changeset
84 <param name="REF_FLAT" value="refFlat.txt" />
844fa42ad305 Uploaded
devteam
parents:
diff changeset
85 <param name="malevel" value="ALL_READS" />
844fa42ad305 Uploaded
devteam
parents:
diff changeset
86 <param name="MINIMUM_LENGTH" value="500" />
844fa42ad305 Uploaded
devteam
parents:
diff changeset
87 <param name="STRAND_SPECIFICITY" value="NONE" />
844fa42ad305 Uploaded
devteam
parents:
diff changeset
88 <param name="RRNA_FRAGMENT_PERCENTAGE" value="0.8" />
844fa42ad305 Uploaded
devteam
parents:
diff changeset
89 <output name="html_file" file="outputrnaseqmetrics.html" ftype="html" lines_diff="30"/>
844fa42ad305 Uploaded
devteam
parents:
diff changeset
90 </test>
844fa42ad305 Uploaded
devteam
parents:
diff changeset
91 </tests>
844fa42ad305 Uploaded
devteam
parents:
diff changeset
92 <help>
844fa42ad305 Uploaded
devteam
parents:
diff changeset
93 Picard documentation says:
844fa42ad305 Uploaded
devteam
parents:
diff changeset
94
844fa42ad305 Uploaded
devteam
parents:
diff changeset
95
844fa42ad305 Uploaded
devteam
parents:
diff changeset
96 CollectRnaSeqMetrics
844fa42ad305 Uploaded
devteam
parents:
diff changeset
97
844fa42ad305 Uploaded
devteam
parents:
diff changeset
98 Documentation: http://picard.sourceforge.net/command-line-overview.shtml#CollectRnaSeqMetrics
844fa42ad305 Uploaded
devteam
parents:
diff changeset
99
844fa42ad305 Uploaded
devteam
parents:
diff changeset
100 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.
844fa42ad305 Uploaded
devteam
parents:
diff changeset
101
844fa42ad305 Uploaded
devteam
parents:
diff changeset
102 </help>
844fa42ad305 Uploaded
devteam
parents:
diff changeset
103 </tool>