annotate picard_SortSam.xml @ 5:3d4f1fa26f0e draft

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