annotate picard_SortSam.xml @ 2:801f5e934011 draft default tip

Uploaded
author devteam
date Thu, 23 Oct 2014 11:40:52 -0400
parents b76a4f17bbbb
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
1 <tool id="picard_SortSam" name="SortSam" version="1.122.0">
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
2
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
3 <description>sort SAM/BAM dataset</description>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
4
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
5 <requirements>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
6 <requirement type="package" version="1.122.0">picard</requirement>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
7 </requirements>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
8
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
9 <macros>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
10 <import>picard_macros.xml</import>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
11 </macros>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
12
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
13 <command>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
14 @java_options@
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
15 java -jar \$JAVA_JAR_PATH/SortSam.jar
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
16 INPUT="${inputFile}"
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
17 OUTPUT="${outFile}"
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
18 SORT_ORDER="${sort_order}"
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
19 QUIET=true
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
20 VERBOSITY=ERROR
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
21 VALIDATION_STRINGENCY=${validation_stringency}
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
22 </command>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
23
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
24 <inputs>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
25 <param name="inputFile" type="data" format="sam,bam" label="Select SAM/BAM dataset or dataset collection" help="If empty, upload or import a SAM/BAM dataset"/>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
26 <param name="sort_order" type="select" display="radio" label="Sort order" help="SORT_ORDER; default=coordinate">
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
27 <option value="coordinate" selected="True">Coordinate</option>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
28 <option value="queryname">Queryname</option>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
29 <option value="unsorted">Unsorted</option>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
30 </param>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
31 <expand macro="VS" />
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
32 </inputs>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
33
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
34 <outputs>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
35 <data name="outFile" format="bam" label="${tool.name} on ${on_string}: BAM sorted in ${sort_order} order">
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
36 </data>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
37 </outputs>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
38
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
39 <stdio>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
40 <exit_code range="1:" level="fatal"/>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
41 </stdio>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
42
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
43 <tests>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
44 <test>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
45 <param name="inputFile" ftype="bam" value="picard_SortSam.bam" />
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
46 <param name="sort_order" value="queryname"/>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
47 <output name="outFile" file="picard_SortSam_test1.bam" ftype="bam" lines_diff="2"/>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
48 </test>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
49 </tests>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
50
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
51 <help>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
52
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
53 .. class:: infomark
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
54
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
55 **Purpose**
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
56
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
57 Sorts the input SAM or BAM.
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
58
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
59 @dataset_collections@
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
60
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
61 @description@
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
62
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
63 SORT_ORDER=SortOrder
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
64 SO=SortOrder Sort order of output file Required. Possible values: {unsorted, queryname, coordinate}
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
65
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
66 @more_info@
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
67
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
68 </help>
b76a4f17bbbb Uploaded
devteam
parents:
diff changeset
69 </tool>