annotate picard_ReorderSam.xml @ 4:ab1f60c26526 draft

Uploaded valid tools and complex repository dependency definition.
author devteam
date Fri, 21 Feb 2014 12:07:49 -0500
parents 9227b8c3093b
children 3d4f1fa26f0e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
1 <tool name="Reorder SAM/BAM" id="picard_ReorderSam" version="1.56.0">
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
2 <requirements><requirement type="package" version="1.56.0">picard</requirement></requirements>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
3 <command interpreter="python">
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
4 picard_wrapper.py
2
9227b8c3093b Updated command line format per dev team standards.
devteam <devteam@galaxyproject.org>
parents: 0
diff changeset
5 --input="${inputFile}"
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
6 #if $source.indexSource == "built-in"
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
7 --ref="${source.ref.fields.path}"
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
8 #else
2
9227b8c3093b Updated command line format per dev team standards.
devteam <devteam@galaxyproject.org>
parents: 0
diff changeset
9 --ref-file="${refFile}"
9227b8c3093b Updated command line format per dev team standards.
devteam <devteam@galaxyproject.org>
parents: 0
diff changeset
10 --species-name="${source.speciesName}"
9227b8c3093b Updated command line format per dev team standards.
devteam <devteam@galaxyproject.org>
parents: 0
diff changeset
11 --build-name="${source.buildName}"
9227b8c3093b Updated command line format per dev team standards.
devteam <devteam@galaxyproject.org>
parents: 0
diff changeset
12 --trunc-names="${source.truncateSeqNames}"
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
13 #end if
2
9227b8c3093b Updated command line format per dev team standards.
devteam <devteam@galaxyproject.org>
parents: 0
diff changeset
14 --allow-inc-dict-concord="${allowIncDictConcord}"
9227b8c3093b Updated command line format per dev team standards.
devteam <devteam@galaxyproject.org>
parents: 0
diff changeset
15 --allow-contig-len-discord="${allowContigLenDiscord}"
9227b8c3093b Updated command line format per dev team standards.
devteam <devteam@galaxyproject.org>
parents: 0
diff changeset
16 --output-format="${outputFormat}"
9227b8c3093b Updated command line format per dev team standards.
devteam <devteam@galaxyproject.org>
parents: 0
diff changeset
17 --output="${outFile}"
0
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
18 --tmpdir "${__new_file_path__}"
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
19 -j "\$JAVA_JAR_PATH/ReorderSam.jar"
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
20 </command>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
21 <inputs>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
22 <param format="bam,sam" name="inputFile" type="data" label="SAM/BAM dataset to be reordered"
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
23 help="If empty, upload or import a SAM/BAM dataset." />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
24 <conditional name="source">
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
25 <param name="indexSource" type="select" label="Select Reference Genome" help="This tool will re-order SAM/BAM in the same order as reference selected below.">
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
26 <option value="built-in">Locally cached</option>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
27 <option value="history">History</option>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
28 </param>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
29 <when value="built-in">
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
30 <param name="ref" type="select" label="Select a reference genome">
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
31 <options from_data_table="picard_indexes" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
32 </param>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
33 </when>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
34 <when value="history">
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
35 <param name="refFile" type="data" format="fasta" metadata_name="dbkey" label="Using reference file" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
36 <param name="speciesName" type="text" value="" label="Species name" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
37 <param name="buildName" type="text" value="" label="Build name" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
38 <param name="truncateSeqNames" type="boolean" checked="False" truevalue="true" falsevalue="false" label="Truncate sequence names after first whitespace" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
39 </when>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
40 </conditional>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
41 <param name="allowIncDictConcord" type="boolean" checked="False" truevalue="true" falsevalue="false" label="Allow incomplete dict concordance?" help="Allows a partial overlap of the BAM contigs with the new reference sequence contigs." />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
42 <param name="allowContigLenDiscord" type="boolean" checked="False" truevalue="true" falsevalue="false" label="Allow contig length discordance?" help="This is dangerous--don't check it unless you know exactly what you're doing!" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
43 <param name="outputFormat" type="boolean" checked="True" truevalue="bam" falsevalue="sam" label="Output BAM instead of SAM" help="Uncheck for SAM output" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
44 </inputs>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
45 <outputs>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
46 <data name="outFile" format="bam" label="${tool.name} on ${on_string}: reordered ${outputFormat}">
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
47 <change_format>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
48 <when input="outputFormat" value="sam" format="sam" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
49 </change_format>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
50 </data>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
51 </outputs>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
52 <tests>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
53 <test>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
54 <!-- Commands:
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
55 cp test-data/phiX.fasta .
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
56 samtools faidx phiX.fasta
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
57 java -jar CreateSequenceDictionary.jar R=phiX.fasta O=phiX.dict URI=phiX.fasta TRUNCATE_NAMES_AT_WHITESPACE=false SPECIES=phiX174
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
58 java -jar ReorderSam.jar VALIDATION_STRINGENCY=LENIENT I=test-data/picard_RS_input1.bam O=picard_RS_output1.bam REFERENCE=phiX.fasta ALLOW_INCOMPLETE_DICT_CONCORDANCE=false ALLOW_CONTIG_LENGTH_DISCORDANCE=false
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
59 -->
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
60 <param name="inputFile" value="picard_RS_input1.bam" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
61 <param name="indexSource" value="history" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
62 <param name="refFile" value="phiX.fasta" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
63 <param name="speciesName" value="phiX174" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
64 <param name="buildName" value="" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
65 <param name="truncateSeqNames" value="false" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
66 <param name="allowIncDictConcord" value="false" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
67 <param name="allowContigLenDiscord" value="false" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
68 <param name="outputFormat" value="True" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
69 <output name="outFile" file="picard_RS_output1.bam" ftype="bam" lines_diff="4" compare="contains" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
70 </test>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
71 <test>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
72 <!-- Command:
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
73 java -jar ReorderSam.jar VALIDATION_STRINGENCY=LENIENT I=test-data/picard_RS_input2.sam O=picard_RS_output2.sam REFERENCE=/path/to/phiX/picard_index/phiX.fa ALLOW_INCOMPLETE_DICT_CONCORDANCE=false ALLOW_CONTIG_LENGTH_DISCORDANCE=false
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
74 /path/to/phiX/srma_index/phiX.fa is path to phiX.fa, phiX.fa.fai, and phiX.dict
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
75 -->
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
76 <param name="inputFile" value="picard_RS_input2.sam" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
77 <param name="indexSource" value="built-in" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
78 <param name="ref" value="phiX" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
79 <param name="allowIncDictConcord" value="false" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
80 <param name="allowContigLenDiscord" value="false" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
81 <param name="outputFormat" value="False" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
82 <output name="outFile" file="picard_RS_output2.sam" ftype="sam" lines_diff="4" sort="True" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
83 </test>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
84 <test>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
85 <!-- Commands:
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
86 cp test-data/picard_RS_input4.fasta .
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
87 samtools faidx picard_RS_input4.fasta
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
88 java -jar CreateSequenceDictionary.jar R=picard_RS_input4.fasta O=picard_RS_input4.dict URI=picard_RS_input4.fasta TRUNCATE_NAMES_AT_WHITESPACE=true SPECIES=phiX174 GENOME_ASSEMBLY=phiX_buildBlah1.1
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
89 java -jar ReorderSam.jar VALIDATION_STRINGENCY=LENIENT I=test-data/picard_RS_input3.bam O=picard_RS_output3.sam REFERENCE=picard_RS_input4.fasta ALLOW_INCOMPLETE_DICT_CONCORDANCE=true ALLOW_CONTIG_LENGTH_DISCORDANCE=false
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
90 picard_RS_input3.bam can be made from picard_RS_input3.sam
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
91 -->
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
92 <param name="inputFile" value="picard_RS_input3.bam" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
93 <param name="indexSource" value="history" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
94 <param name="refFile" value="picard_RS_input4.fasta" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
95 <param name="speciesName" value="phiX174" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
96 <param name="buildName" value="phiX_buildBlah1.1" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
97 <param name="truncateSeqNames" value="true" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
98 <param name="allowIncDictConcord" value="true" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
99 <param name="allowContigLenDiscord" value="false" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
100 <param name="outputFormat" value="False" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
101 <output name="outFile" file="picard_RS_output3.sam" ftype="sam" lines_diff="12" sort="True" />
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
102 </test>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
103 </tests>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
104 <help>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
105
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
106 .. class:: infomark
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
107
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
108 **Purpose**
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
109
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
110 Reorder SAM/BAM to match contig ordering in a particular reference file. Note that this is
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
111 not the same as sorting as done by the SortSam tool, which sorts by either coordinate
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
112 values or query name. The ordering in ReorderSam is based on exact name matching of
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
113 contigs/chromosomes. Reads that are mapped to a contig that is not in the new reference file are
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
114 not included in the output.
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
115
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
116 **Picard documentation**
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
117
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
118 This is a Galaxy wrapper for ReorderSam, a part of the external package Picard-tools_.
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
119
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
120 .. _Picard-tools: http://www.google.com/search?q=picard+samtools
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
121
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
122 ------
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
123
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
124 .. class:: infomark
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
125
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
126 **Inputs, outputs, and parameters**
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
127
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
128 For the file that needs to be reordered, either a sam file or a bam file must be supplied.
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
129 If a bam file is used, it must be coordinate-sorted. A reference file is also required,
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
130 so either a fasta file should be supplied or a built-in reference can be selected.
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
131
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
132 The output contains the same reads as the input file but the reads have been rearranged so
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
133 they appear in the same order as the provided reference file. The tool will output either
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
134 bam (the default) or sam, according to user selection. Bam is recommended since it is smaller.
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
135
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
136 The only extra parameters that can be set are flags for allowing incomplete dict concordance
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
137 and allowing contig length discordance. If incomplete dict concordance is allowed, only a
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
138 partial overlap of the bam contigs with the new reference sequence contigs is required. By
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
139 default it is off, requiring a corresponding contig in the new reference for each read contig.
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
140 If contig length discordance is allowed, contig names that are the same between a read and the
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
141 new reference contig are allowed even if they have different lengths. This is usually not a
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
142 good idea, unless you know exactly what you're doing. It's off by default.
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
143
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
144 .. class:: warningmark
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
145
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
146 **Warning on SAM/BAM quality**
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
147
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
148 Many SAM/BAM files produced externally and uploaded to Galaxy do not fully conform to SAM/BAM specifications. Galaxy deals with this by using the **LENIENT**
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
149 flag when it runs Picard, which allows reads to be discarded if they're empty or don't map. This appears
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
150 to be the only way to deal with SAM/BAM that cannot be parsed.
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
151
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
152
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
153 </help>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
154 </tool>
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
155
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
156
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
157
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
158
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
159
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
160
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
161
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
162
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
163
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
164
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
165
1cd7f3b42609 Uploaded tool.
devteam
parents:
diff changeset
166