annotate picard_MergeSamFiles.xml @ 12:05087b27692a draft

planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
author devteam
date Sun, 27 Nov 2016 15:11:50 -0500
parents 5eaa8a968300
children 7e6fd3d0f16e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8
3a3234d7a2e8 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents: 5
diff changeset
1 <tool name="MergeSamFiles" id="picard_MergeSamFiles" version="@TOOL_VERSION@.0">
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
2 <description>merges multiple SAM/BAM datasets into one</description>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
3 <macros>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
4 <import>picard_macros.xml</import>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
5 </macros>
8
3a3234d7a2e8 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents: 5
diff changeset
6 <expand macro="requirements" />
12
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 9
diff changeset
7 <command detect_errors="exit_code"><![CDATA[
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
8 @java_options@
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
9
12
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 9
diff changeset
10 picard
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
11 MergeSamFiles
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
12
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
13 #for $element in $inputFile:
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
14 INPUT="${element}"
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
15 #end for
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
16
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
17 OUTPUT="${outFile}"
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
18 MERGE_SEQUENCE_DICTIONARIES="${merge_sequence_dictionaries}"
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
19
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
20 ASSUME_SORTED="${assume_sorted}"
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
21 #for $element in $comments:
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
22 COMMENT="${element.comment}"
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
23 #end for
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
24
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
25 USE_THREADING=true
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
26 SORT_ORDER=coordinate
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
27 VALIDATION_STRINGENCY="${validation_stringency}"
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
28 QUIET=true
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
29 VERBOSITY=ERROR
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
30
12
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 9
diff changeset
31 ]]></command>
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
32 <inputs>
3d4f1fa26f0e Uploaded
devteam
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"/>
3d4f1fa26f0e Uploaded
devteam
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"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
35 <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
36
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
37 <repeat name="comments" title="Comment" min="0" help="You can provide multiple comments">
9
5eaa8a968300 planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 1869970193a1878acbc0f8a79b81dd02b37f1dc1
devteam
parents: 8
diff changeset
38 <param name="comment" type="text" label="Add this comment to BAM dataset" help="COMMENT"/>
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
39 </repeat>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
40
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
41 <expand macro="VS" />
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
42
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
43 </inputs>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
44
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
45 <outputs>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
46 <data format="bam" name="outFile" label="${tool.name} on ${on_string}: Merged BAM dataset"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
47 </outputs>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
48
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
49 <tests>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
50 <test>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
51 <param name="inputFile" value="picard_MergeSamFiles_input1.bam,picard_MergeSamFiles_input2.bam,picard_MergeSamFiles_input3.bam" ftype="bam"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
52 <param name="assume_sorted" value="False"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
53 <param name="merge_sequence_dictionaries" value="False"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
54 <param name="validation_stringency" value="LENIENT"/>
12
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 9
diff changeset
55 <output name="outFile" file="picard_MergeSamFiles_test1.bam" ftype="bam" lines_diff="4"/>
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
56 </test>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
57 </tests>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
58
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
59
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
60 <help>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
61
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
62 **Purpose**
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
63
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
64 Merges multiple SAM/BAM datasets into one.
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
65
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
66 @dataset_collections@
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
67
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
68 @description@
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
69
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
70 ASSUME_SORTED=Boolean
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
71 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
72 sort order, even if their headers say otherwise. Default value: false. This option can
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
73 be set to 'null' to clear the default value. Possible values: {true, false}
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
74
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
75 MERGE_SEQUENCE_DICTIONARIES=Boolean
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
76 MSD=Boolean Merge the sequence dictionaries Default value: false. This option can be set to 'null'
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
77 to clear the default value. Possible values: {true, false}
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
78
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
79 COMMENT=String
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
80 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
81 or more times.
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
82
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
83
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
84 @more_info@
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
85
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
86 </help>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
87 </tool>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
88
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
89