annotate picard_MergeSamFiles.xml @ 6:4ff1e04010e6 draft

Uploaded
author devteam
date Thu, 15 Jan 2015 15:37:04 -0500
parents 3d4f1fa26f0e
children 3a3234d7a2e8
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
1 <tool name="MergeSamFiles" id="picard_MergeSamFiles" version="1.126.0">
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
2 <description>merges multiple SAM/BAM datasets into one</description>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
3 <requirements>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
4 <requirement type="package" version="1.126.0">picard</requirement>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
5 </requirements>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
6
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
7 <macros>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
8 <import>picard_macros.xml</import>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
9 </macros>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
10
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
11 <command>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
12 @java_options@
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
13
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
14 java -jar \$JAVA_JAR_PATH/picard.jar
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
15 MergeSamFiles
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
16
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
17 #for $element in $inputFile:
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
18 INPUT="${element}"
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
19 #end for
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
20
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
21 OUTPUT="${outFile}"
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
22 MERGE_SEQUENCE_DICTIONARIES="${merge_sequence_dictionaries}"
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
23
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
24 ASSUME_SORTED="${assume_sorted}"
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
25 #for $element in $comments:
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
26 COMMENT="${element.comment}"
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
27 #end for
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
28
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
29 USE_THREADING=true
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
30 SORT_ORDER=coordinate
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
31 VALIDATION_STRINGENCY="${validation_stringency}"
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
32 QUIET=true
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
33 VERBOSITY=ERROR
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
34
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
35 </command>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
36 <inputs>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
37 <param format="sam,bam" name="inputFile" type="data" multiple="True" label="Select SAM/BAM dataset or dataset collection" help="If empty, upload or import a SAM/BAM dataset"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
38 <param name="merge_sequence_dictionaries" type="boolean" label="Merge the sequence dictionaries of the datasets being merged" help="MERGE_SEQUENCE_DICTIONARIES; default=False"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
39 <param name="assume_sorted" type="boolean" label="Assume the input file is already sorted" help="ASSUME_SORTED; default=False"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
40
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
41 <repeat name="comments" title="Comment" min="0" help="You can provide multiple comments">
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
42 <param name="comment" type="text" size="50" label="Add this comment to BAM dataset" help="COMMENT"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
43 </repeat>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
44
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
45 <expand macro="VS" />
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
46
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
47 </inputs>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
48
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
49 <outputs>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
50 <data format="bam" name="outFile" label="${tool.name} on ${on_string}: Merged BAM dataset"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
51 </outputs>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
52
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
53 <tests>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
54 <test>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
55 <param name="inputFile" value="picard_MergeSamFiles_input1.bam,picard_MergeSamFiles_input2.bam,picard_MergeSamFiles_input3.bam" ftype="bam"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
56 <param name="assume_sorted" value="False"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
57 <param name="merge_sequence_dictionaries" value="False"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
58 <param name="validation_stringency" value="LENIENT"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
59 <output name="outFile" file="picard_MergeSamFiles_test1.bam" ftype="bam" lines_diff="2"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
60 </test>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
61 </tests>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
62
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
63 <stdio>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
64 <exit_code range="1:" level="fatal"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
65 </stdio>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
66
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
67 <help>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
68
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
69 **Purpose**
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
70
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
71 Merges multiple SAM/BAM datasets into one.
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
72
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
73 @dataset_collections@
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
74
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
75 @description@
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
76
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
77 ASSUME_SORTED=Boolean
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
78 AS=Boolean If true, assume that the input files are in the same sort order as the requested output
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
79 sort order, even if their headers say otherwise. Default value: false. This option can
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
80 be set to 'null' to clear the default value. Possible values: {true, false}
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
81
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
82 MERGE_SEQUENCE_DICTIONARIES=Boolean
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
83 MSD=Boolean Merge the sequence dictionaries Default value: false. This option can be set to 'null'
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
84 to clear the default value. Possible values: {true, false}
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
85
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
86 COMMENT=String
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
87 CO=String Comment(s) to include in the merged output file's header. This option may be specified 0
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
88 or more times.
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
89
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
90
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
91 @more_info@
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
92
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
93 </help>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
94 </tool>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
95
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
96