annotate picard_SortSam.xml @ 86:c6b177fcac2e draft

Uploaded
author devteam
date Mon, 24 Feb 2014 00:32:46 -0500
parents fda8c1757585
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
67
fda8c1757585 Uploaded
devteam
parents:
diff changeset
1 <tool name="Sort Sam" id="picard_SortSam" version="1.106.0">
fda8c1757585 Uploaded
devteam
parents:
diff changeset
2 <!-- adapted from https://github.com/najoshi/ucd-biocore-galaxy/blob/master/tools/picard/picard_SortSam.xml -->
fda8c1757585 Uploaded
devteam
parents:
diff changeset
3 <!-- warning: the sam format output doesn't work. TODO: fix it -->
fda8c1757585 Uploaded
devteam
parents:
diff changeset
4 <description>Sorts SAM or BAM file</description>
fda8c1757585 Uploaded
devteam
parents:
diff changeset
5 <requirements><requirement type="package" version="1.106.0">picard</requirement></requirements>
fda8c1757585 Uploaded
devteam
parents:
diff changeset
6 <command interpreter="python">
fda8c1757585 Uploaded
devteam
parents:
diff changeset
7 picard_wrapper.py
fda8c1757585 Uploaded
devteam
parents:
diff changeset
8 --input "$inputFile"
fda8c1757585 Uploaded
devteam
parents:
diff changeset
9 -s "$sort_order"
fda8c1757585 Uploaded
devteam
parents:
diff changeset
10 -o "$outFile"
fda8c1757585 Uploaded
devteam
parents:
diff changeset
11 --output-format $outputFormat
fda8c1757585 Uploaded
devteam
parents:
diff changeset
12 -j "\$JAVA_JAR_PATH/SortSam.jar"
fda8c1757585 Uploaded
devteam
parents:
diff changeset
13 </command>
fda8c1757585 Uploaded
devteam
parents:
diff changeset
14 <inputs>
fda8c1757585 Uploaded
devteam
parents:
diff changeset
15 <param format="bam,sam" name="inputFile" type="data" label="SAM/BAM dataset to be sorted"
fda8c1757585 Uploaded
devteam
parents:
diff changeset
16 help="If empty, upload or import a SAM/BAM dataset." />
fda8c1757585 Uploaded
devteam
parents:
diff changeset
17 <param name="sort_order" type="select" label="Sort order">
fda8c1757585 Uploaded
devteam
parents:
diff changeset
18 <option value="coordinate" selected="True">coordinate</option>
fda8c1757585 Uploaded
devteam
parents:
diff changeset
19 <option value="queryname">queryname</option>
fda8c1757585 Uploaded
devteam
parents:
diff changeset
20 <option value="unsorted">unsorted</option>
fda8c1757585 Uploaded
devteam
parents:
diff changeset
21 </param>
fda8c1757585 Uploaded
devteam
parents:
diff changeset
22 <param name="outputFormat" type="boolean" checked="True" truevalue="bam" falsevalue="sam" label="Output BAM instead of SAM" help="Uncheck for SAM output" />
fda8c1757585 Uploaded
devteam
parents:
diff changeset
23 </inputs>
fda8c1757585 Uploaded
devteam
parents:
diff changeset
24 <outputs>
fda8c1757585 Uploaded
devteam
parents:
diff changeset
25 <data name="outFile" format="bam" label="${tool.name} on ${on_string}: ${outputFormat}" />
fda8c1757585 Uploaded
devteam
parents:
diff changeset
26 <change_format>
fda8c1757585 Uploaded
devteam
parents:
diff changeset
27 <when input="outputFormat" value="sam" format="sam" />
fda8c1757585 Uploaded
devteam
parents:
diff changeset
28 </change_format>
fda8c1757585 Uploaded
devteam
parents:
diff changeset
29 </outputs>
fda8c1757585 Uploaded
devteam
parents:
diff changeset
30 <help>
fda8c1757585 Uploaded
devteam
parents:
diff changeset
31
fda8c1757585 Uploaded
devteam
parents:
diff changeset
32 SortSam
fda8c1757585 Uploaded
devteam
parents:
diff changeset
33
fda8c1757585 Uploaded
devteam
parents:
diff changeset
34 USAGE: SortSam [options]
fda8c1757585 Uploaded
devteam
parents:
diff changeset
35
fda8c1757585 Uploaded
devteam
parents:
diff changeset
36 Documentation: http://picard.sourceforge.net/command-line-overview.shtml#SortSam
fda8c1757585 Uploaded
devteam
parents:
diff changeset
37
fda8c1757585 Uploaded
devteam
parents:
diff changeset
38 Sorts the input SAM or BAM.
fda8c1757585 Uploaded
devteam
parents:
diff changeset
39
fda8c1757585 Uploaded
devteam
parents:
diff changeset
40 Input and output formats are determined by file extension.
fda8c1757585 Uploaded
devteam
parents:
diff changeset
41 Option Description
fda8c1757585 Uploaded
devteam
parents:
diff changeset
42 INPUT=File The BAM or SAM file to sort. Required.
fda8c1757585 Uploaded
devteam
parents:
diff changeset
43 OUTPUT=File The sorted BAM or SAM output file. Required.
fda8c1757585 Uploaded
devteam
parents:
diff changeset
44 SORT_ORDER=SortOrder Sort order of output file Required. Possible values: {unsorted, queryname, coordinate}
fda8c1757585 Uploaded
devteam
parents:
diff changeset
45 </help>
fda8c1757585 Uploaded
devteam
parents:
diff changeset
46 </tool>
fda8c1757585 Uploaded
devteam
parents:
diff changeset
47
fda8c1757585 Uploaded
devteam
parents:
diff changeset
48
fda8c1757585 Uploaded
devteam
parents:
diff changeset
49
fda8c1757585 Uploaded
devteam
parents:
diff changeset
50