annotate picard_MergeSamFiles.xml @ 20:2a17c789e0a5 draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 5ebd6c8453b49dd6a36e372eb1eb6e323bb7ad8a
author iuc
date Tue, 19 Jun 2018 11:28:49 -0400
parents 5053a18d9bc8
children f9242e01365a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
19
5053a18d9bc8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 7036343b9ac0a0ffc2ce4f6db465b9298ef05e73
iuc
parents: 13
diff changeset
1 <tool name="MergeSamFiles" id="picard_MergeSamFiles" version="@TOOL_VERSION@.@WRAPPER_VERSION@">
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>
20
2a17c789e0a5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 5ebd6c8453b49dd6a36e372eb1eb6e323bb7ad8a
iuc
parents: 19
diff changeset
5 <token name="@WRAPPER_VERSION@">1</token>
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
6 </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
7 <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
8 <command detect_errors="exit_code"><![CDATA[
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
9 @java_options@
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
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
12
5
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
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
16
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
17 OUTPUT="${outFile}"
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
18 MERGE_SEQUENCE_DICTIONARIES="${merge_sequence_dictionaries}"
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
19
5
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
20
2a17c789e0a5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 5ebd6c8453b49dd6a36e372eb1eb6e323bb7ad8a
iuc
parents: 19
diff changeset
30 @TMPDIR_OPTION@
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
31
12
05087b27692a planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents: 9
diff changeset
32 ]]></command>
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
33 <inputs>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
34 <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
35 <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
36 <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
37
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
38 <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
39 <param name="comment" type="text" label="Add this comment to BAM dataset" help="COMMENT"/>
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
40 </repeat>
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
41
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
42 <expand macro="VS" />
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
43
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
44 </inputs>
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
45
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
46 <outputs>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
47 <data format="bam" name="outFile" label="${tool.name} on ${on_string}: Merged BAM dataset"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
48 </outputs>
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
49
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
50 <tests>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
51 <test>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
52 <param name="inputFile" value="picard_MergeSamFiles_input1.bam,picard_MergeSamFiles_input2.bam,picard_MergeSamFiles_input3.bam" ftype="bam"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
53 <param name="assume_sorted" value="False"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
54 <param name="merge_sequence_dictionaries" value="False"/>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
55 <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
56 <output name="outFile" file="picard_MergeSamFiles_test1.bam" ftype="bam" lines_diff="4"/>
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
57 </test>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
58 </tests>
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
59
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
60
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
61 <help>
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
62
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
63 **Purpose**
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
64
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
65 Merges multiple SAM/BAM datasets into one.
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
66
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
67 @dataset_collections@
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
68
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
69 @description@
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
70
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
71 ASSUME_SORTED=Boolean
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
72 AS=Boolean If true, assume that the input files are in the same sort order as the requested output
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
73 sort order, even if their headers say otherwise. Default value: false. This option can
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
74 be set to 'null' to clear the default value. Possible values: {true, false}
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
75
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
76 MERGE_SEQUENCE_DICTIONARIES=Boolean
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
77 MSD=Boolean Merge the sequence dictionaries Default value: false. This option can be set to 'null'
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
78 to clear the default value. Possible values: {true, false}
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
79
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
80 COMMENT=String
13
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
81 CO=String Comment(s) to include in the merged output file's header. This option may be specified 0
7e6fd3d0f16e planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents: 12
diff changeset
82 or more times.
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
83
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
84
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
85 @more_info@
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
86
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
87 </help>
19
5053a18d9bc8 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 7036343b9ac0a0ffc2ce4f6db465b9298ef05e73
iuc
parents: 13
diff changeset
88 <expand macro="citations" />
5
3d4f1fa26f0e Uploaded
devteam
parents:
diff changeset
89 </tool>