annotate picard_MergeSamFiles.xml @ 1:5f1da1eadb39 draft default tip

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