Mercurial > repos > devteam > picard
annotate picard_MergeBamAlignment.xml @ 19:5053a18d9bc8 draft
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 7036343b9ac0a0ffc2ce4f6db465b9298ef05e73
author | iuc |
---|---|
date | Mon, 16 Apr 2018 21:27:29 -0400 |
parents | 7e6fd3d0f16e |
children | 2a17c789e0a5 |
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="MergeBamAlignment" id="picard_MergeBamAlignment" version="@TOOL_VERSION@.@WRAPPER_VERSION@"> |
5 | 2 <description>merge alignment data with additional info stored in an unmapped BAM dataset</description> |
3 <macros> | |
4 <import>picard_macros.xml</import> | |
19
5053a18d9bc8
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 7036343b9ac0a0ffc2ce4f6db465b9298ef05e73
iuc
parents:
13
diff
changeset
|
5 <token name="@WRAPPER_VERSION@">0</token> |
5 | 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 | 9 @java_options@ |
10 #set $picard_dict = "localref.dict" | |
11 #set $ref_fasta = "localref.fa" ## This is done because picards "likes" .fa extension | |
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
12 |
12
05087b27692a
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents:
9
diff
changeset
|
13 ln -s "${reference_source.ref_file}" "${ref_fasta}" && |
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
14 |
5 | 15 #if str( $reference_source.reference_source_selector ) == "history": |
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
16 |
12
05087b27692a
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents:
9
diff
changeset
|
17 picard CreateSequenceDictionary REFERENCE="${ref_fasta}" OUTPUT="${picard_dict}" |
5 | 18 QUIET=true |
19 VERBOSITY=ERROR | |
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
20 |
12
05087b27692a
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents:
9
diff
changeset
|
21 && |
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
22 |
5 | 23 #else: |
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
24 |
5 | 25 #set $ref_fasta = str( $reference_source.ref_file.fields.path ) |
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
26 |
5 | 27 #end if |
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
28 |
12
05087b27692a
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents:
9
diff
changeset
|
29 picard |
5 | 30 MergeBamAlignment |
31 UNMAPPED_BAM="${unmapped_bam}" | |
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
32 |
5 | 33 PAIRED_RUN=true ##This argument is ignored and will be removed. Required. Possible values: {true, false} |
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
34 |
5 | 35 #if str( $aligned_or_read1_and_read2.aligned_or_read1_and_read2_selector ) == "paired_one_file": |
36 #for $dataset in $aligned_or_read1_and_read2.aligned_bams: | |
37 ALIGNED_BAM="${dataset.aligned_bam}" | |
38 #end for | |
39 #elif str( $aligned_or_read1_and_read2.aligned_or_read1_and_read2_selector ) == "paired_two_files": | |
40 #for $dataset in $aligned_or_read1_and_read2.read1_aligned_bams: | |
41 READ1_ALIGNED_BAM="${dataset.read1_aligned_bam}" | |
42 #end for | |
43 #for $dataset in $aligned_or_read1_and_read2.read2_aligned_bams: | |
8
3a3234d7a2e8
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 00a7926c285bc4a339bd7deebf40b28f39c7d947-dirty
devteam
parents:
5
diff
changeset
|
44 READ2_ALIGNED_BAM="${dataset.read2_aligned_bam}" |
5 | 45 #end for |
46 #else | |
47 #for $dataset in $aligned_or_read1_and_read2.read1_aligned_bams: | |
48 READ1_ALIGNED_BAM="${dataset.read1_aligned_bam}" | |
49 #end for | |
50 #end if | |
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
51 |
5 | 52 OUTPUT="${outFile}" |
53 REFERENCE_SEQUENCE="${ref_fasta}" | |
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
54 |
5 | 55 CLIP_ADAPTERS="${clip_adapters}" |
56 IS_BISULFITE_SEQUENCE="${is_bisulfite_sequence}" | |
57 ALIGNED_READS_ONLY="${aligned_reads_only}" | |
58 MAX_INSERTIONS_OR_DELETIONS="${max_insertions_or_deletions}" | |
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
59 |
5 | 60 #for $attribute in $attributes_to_retain: |
61 ATTRIBUTES_TO_RETAIN="${$attribute.attribute}" | |
62 #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
|
63 |
5 | 64 #for $attribute in $attributes_to_remove: |
65 ATTRIBUTES_TO_REMOVE="${$attribute.attribute}" | |
66 #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
|
67 |
5 | 68 READ1_TRIM="${read1_trim}" |
69 READ2_TRIM="${read2_trim}" | |
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
70 |
5 | 71 #if str( $orientations ) != "None": |
72 #for $orientation in str( $orientations ).split(','): ## See trello card https://trello.com/c/9nW02Zhd | |
73 EXPECTED_ORIENTATIONS="${orientation}" | |
74 #end for | |
75 #end if | |
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
76 |
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
77 ALIGNER_PROPER_PAIR_FLAGS="${aligner_proper_pair_flags}" |
5 | 78 PRIMARY_ALIGNMENT_STRATEGY="${primary_alignment_strategy}" |
79 CLIP_OVERLAPPING_READS="${clip_overlapping_reads}" | |
80 INCLUDE_SECONDARY_ALIGNMENTS="${include_secondary_alignments}" | |
81 ADD_MATE_CIGAR="${add_mate_cigar}" | |
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
82 |
5 | 83 VALIDATION_STRINGENCY="${validation_stringency}" |
84 | |
85 SORT_ORDER=coordinate | |
86 QUIET=true | |
87 VERBOSITY=ERROR | |
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
88 |
12
05087b27692a
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents:
9
diff
changeset
|
89 ]]></command> |
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
90 |
5 | 91 <inputs> |
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
92 |
5 | 93 <conditional name="reference_source"> |
94 <param name="reference_source_selector" type="select" label="Load reference genome from"> | |
95 <option value="cached">Local cache</option> | |
96 <option value="history">History</option> | |
97 </param> | |
98 <when value="cached"> | |
99 <param name="ref_file" type="select" label="Use dictionary from the list" help="Select genome from the list"> | |
100 <options from_data_table="picard_indexes"> | |
101 <filter type="sort_by" column="2" /> | |
102 <validator type="no_options" message="No indexes are available" /> | |
103 </options> | |
104 <validator type="no_options" message="A built-in dictionary is not available for the build associated with the selected input file"/> | |
105 </param> | |
106 </when> | |
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
107 <when value="history"> |
5 | 108 <param name="ref_file" type="data" format="fasta" label="Use the following dataset to create dictionary" help="You can upload a FASTA sequence to the history from which Picard will automatically generate dictionary using CreateSequenceDictionary command" /> |
109 </when> | |
110 </conditional> | |
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
111 |
5 | 112 <param format="sam,bam" name="unmapped_bam" type="data" label="Selected unaligned SAM or BAM with original reads" help="UNMAPPED_BAM; This dataset must be sorted in queryname order (use picard_SortSam to do this)" /> |
113 <conditional name="aligned_or_read1_and_read2"> | |
114 <param name="aligned_or_read1_and_read2_selector" type="select" label="What type of aligned data do you have?"> | |
115 <option value="paired_one_file">Paired data in a single BAM file (ALIGNED_BAM)</option> | |
116 <option value="paired_two_files">Paired data in separate files (READ1_ALIGNED_BAM and READ2_ALIGNED_BAM)</option> | |
117 <option value="single_file">Singe end data (READ1_ALIGNED_BAM)</option> | |
118 </param> | |
119 <when value="paired_one_file"> | |
120 <repeat name="aligned_bams" title="Aligned SAM or BAM dataset" min="1" help="You can provide multiple datasets"> | |
121 <param name="aligned_bam" type="data" format="sam,bam" label="SAM or BAM dataset(s) with alignment data" help="ALIGNED_BAM"/> | |
122 </repeat> | |
123 </when> | |
124 <when value="paired_two_files"> | |
125 <repeat name="read1_aligned_bams" title="Aligned SAM or BAM dataset for Read 1" min="1" help="You can provide multiple datasets"> | |
126 <param name="read1_aligned_bam" type="data" format="sam,bam" label="SAM or BAM dataset(s) with alignment data for Read1" help="READ1_ALIGNED_BAM"/> | |
127 </repeat> | |
128 <repeat name="read2_aligned_bams" title="Aligned SAM or BAM dataset for Read 2" min="1" help="You can provide multiple datasets"> | |
129 <param name="read2_aligned_bam" type="data" format="sam,bam" label="SAM or BAM dataset(s) with alignment data for Read2" help="READ2_ALIGNED_BAM"/> | |
130 </repeat> | |
131 </when> | |
132 <when value="single_file"> | |
133 <repeat name="read1_aligned_bams" title="Aligned SAM or BAM dataset for Single Reads" min="1" help="You can provide multiple datasets"> | |
134 <param name="read1_aligned_bam" type="data" format="sam,bam" label="SAM or BAM dataset(s) with alignment data" help="READ1_ALIGNED_BAM"/> | |
135 </repeat> | |
136 </when> | |
137 </conditional> | |
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
138 |
5 | 139 <param name="clip_adapters" type="boolean" checked="true" label="Whether to clip adapters where identified" help="CLIP_ADAPTERS; default=True"/> |
140 <param name="is_bisulfite_sequence" type="boolean" label="Whether the data is from bisulfite sequencing (used when caculating the NM tag)" help="IS_BISULFITE_SEQUENCE; default=False"/> | |
141 <param name="aligned_reads_only" type="boolean" label="Whether to output only aligned reads" help="ALIGNED_READS_ONLY; default=False"/> | |
142 <param name="max_insertions_or_deletions" type="integer" value="1" label="The maximum number of insertions or deletions permitted for an alignment to be included" help="MAX_INSERTIONS_OR_DELETIONS; Alignments with more than this many insertions or deletions will be ignored. Set to -1 to allow any number of insertions or deletions. default=1"/> | |
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
143 |
5 | 144 <repeat name="attributes_to_retain" title="Retain the following alignment attribute" min="0" help="You can provide multiple attributes"> |
9
5eaa8a968300
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 1869970193a1878acbc0f8a79b81dd02b37f1dc1
devteam
parents:
8
diff
changeset
|
145 <param name="attribute" type="text" label="Reserved alignment attributes (tags starting with X, Y, or Z) that should be brought over from the alignment data when merging" help="ATTRIBUTES_TO_RETAIN; example: XA"/> |
5 | 146 </repeat> |
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
147 |
5 | 148 <repeat name="attributes_to_remove" title="Remove the following alignment attribute" min="0" help="You can provide multiple attributes"> |
9
5eaa8a968300
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 1869970193a1878acbc0f8a79b81dd02b37f1dc1
devteam
parents:
8
diff
changeset
|
149 <param name="attribute" type="text" label="Attributes from the alignment record that should be removed when merging." help="ATTRIBUTES_TO_REMOVE; This overrides ATTRIBUTES_TO_RETAIN if they share common tags"/> |
5 | 150 </repeat> |
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
151 |
5 | 152 <param name="read1_trim" type="integer" value="0" label="The number of bases trimmed from the beginning of read 1 prior to alignment" help="READ1_TRIM; default=0"/> |
153 <param name="read2_trim" type="integer" value="0" label="The number of bases trimmed from the beginning of read 2 prior to alignment" help="READ2_TRIM; default=0"/> | |
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
154 |
5 | 155 <param name="orientations" type="select" multiple="True" display="checkboxes" label="The expected orientation of proper read pairs" help="EXPECTED_ORIENTATIONS; multiple orinetations can be selected"> |
156 <option value="FR">Forward/Reverse (FR)</option> | |
157 <option value="RF">Reverse/Forward (RF)</option> | |
158 <option value="TANDEM">Tandem</option> | |
159 </param> | |
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
160 |
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
161 |
5 | 162 <param name="aligner_proper_pair_flags" type="boolean" label="Use the aligner's idea of what a proper pair is rather than computing in this program" help="ALIGNER_PROPER_PAIR_FLAGS; default=False"/> |
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
163 |
5 | 164 <param name="primary_alignment_strategy" type="select" label="Strategy for selecting primary alignment when the aligner has provided more than one alignment for a pair or fragments" help="PRIMARY_ALIGNMENT_STRATEGY; see help below for more info; default=BestMapq"> |
165 <option value="BestMapq" selected="True">BestMapq</option> | |
166 <option value="EarliestFragment">EarliestFragment</option> | |
167 <option value="BestEndMapq">BestEndMapq</option> | |
168 <option value="MostDistant">MostDistant</option> | |
169 </param> | |
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
170 |
5 | 171 <param name="clip_overlapping_reads" type="boolean" checked="True" label="For paired reads, soft clip the 3' end of each read if necessary so that it does not extend past the 5' end of its mate" help="CLIP_OVERLAPPING_READS; default=True"/> |
172 <param name="include_secondary_alignments" type="boolean" checked="True" label="If false, do not write secondary alignments to output" help="INCLUDE_SECONDARY_ALIGNMENTS; default=True"/> | |
173 <param name="add_mate_cigar" type="boolean" checked="True" label="Adds the mate CIGAR tag (MC) if true, does not if false" help="ADD_MATE_CIGAR; default=True"/> | |
174 <expand macro="VS" /> | |
175 </inputs> | |
176 <outputs> | |
177 <data name="outFile" format="bam" label="${tool.name} on ${on_string}: BAM with merged alignments"/> | |
178 </outputs> | |
179 <tests> | |
180 <test> | |
181 <param name="reference_source_selector" value="history" /> | |
182 <param name="ref_file" value="picard_MergeBamAlignment_ref.fa" ftype="fasta" /> | |
183 <param name="unmapped_bam" value="picard_MergeBamAlignment_unaligned.bam" ftype="bam"/> | |
184 <param name="aligned_or_read1_and_read2_selector" value="paired_one_file"/> | |
185 <param name="aligned_bam" value="picard_MergeBamAlignment_aligned.bam" ftype="bam"/> | |
186 <param name="clip_adapters" value="True"/> | |
187 <param name="is_bisulfite_sequence" value="False"/> | |
188 <param name="aligned_reads_only" value="False"/> | |
189 <param name="max_insertions_or_deletions" value="1"/> | |
190 <param name="read1_trim" value="0"/> | |
191 <param name="read2_trim" value="0"/> | |
192 <param name="orientation" value="FR"/> | |
193 <param name="aligner_proper_pair_flags" value="False"/> | |
194 <param name="primary_alignment_strategy" value="BestMapq"/> | |
195 <param name="clip_overlapping_reads" value="True"/> | |
196 <param name="include_secondary_alignments" value="True"/> | |
197 <param name="add_mate_cigar" value="True"/> | |
12
05087b27692a
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit 7491208ca0c917a053798a48c3e54c3e30e95d92
devteam
parents:
9
diff
changeset
|
198 <output name="outFile" file="picard_MergeBamAlignment_test1.bam" ftype="bam" lines_diff="4"/> |
5 | 199 </test> |
200 </tests> | |
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
201 |
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
202 |
5 | 203 <help> |
204 | |
205 .. class:: infomark | |
206 | |
207 **Purpose** | |
208 | |
209 Merges alignment data from a SAM or BAM dataset with additional data stored in an unmapped BAM dataset and produces a third SAM or BAM dataset of aligned and unaligned reads. | |
210 | |
211 @dataset_collections@ | |
212 | |
213 @description@ | |
214 | |
215 UNMAPPED_BAM=File | |
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
216 UNMAPPED=File Original SAM or BAM file of unmapped reads, which must be in queryname order. Required. |
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
217 |
5 | 218 ALIGNED_BAM=File |
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
219 ALIGNED=File SAM or BAM file(s) with alignment data. This option may be specified 0 or more times. |
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
220 Cannot be used in conjuction with option(s) READ1_ALIGNED_BAM (R1_ALIGNED) |
5 | 221 READ2_ALIGNED_BAM (R2_ALIGNED) |
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
222 |
5 | 223 READ1_ALIGNED_BAM=File |
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
224 R1_ALIGNED=File SAM or BAM file(s) with alignment data from the first read of a pair. This option may be |
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
225 specified 0 or more times. Cannot be used in conjuction with option(s) ALIGNED_BAM |
5 | 226 (ALIGNED) |
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
227 |
5 | 228 READ2_ALIGNED_BAM=File |
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
229 R2_ALIGNED=File SAM or BAM file(s) with alignment data from the second read of a pair. This option may |
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
230 be specified 0 or more times. Cannot be used in conjuction with option(s) ALIGNED_BAM |
5 | 231 (ALIGNED) |
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
232 |
5 | 233 PAIRED_RUN=Boolean |
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
234 PE=Boolean This argument is ignored and will be removed. Required. 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
|
235 |
5 | 236 JUMP_SIZE=Integer |
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
237 JUMP=Integer The expected jump size (required if this is a jumping library). Deprecated. Use |
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
238 EXPECTED_ORIENTATIONS instead Default value: null. Cannot be used in conjuction with |
5 | 239 option(s) EXPECTED_ORIENTATIONS (ORIENTATIONS) |
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
240 |
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
241 CLIP_ADAPTERS=Boolean Whether to clip adapters where identified. Default value: true. 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
|
242 |
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
243 IS_BISULFITE_SEQUENCE=Boolean Whether the lane is bisulfite sequence (used when caculating the NM tag). Default value: |
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
244 false. 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
|
245 |
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
246 ALIGNED_READS_ONLY=Boolean Whether to output only aligned reads. Default value: false. 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
|
247 |
5 | 248 MAX_INSERTIONS_OR_DELETIONS=Integer |
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
249 MAX_GAPS=Integer The maximum number of insertions or deletions permitted for an alignment to be included. |
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
250 Alignments with more than this many insertions or deletions will be ignored. Set to -1 to |
5 | 251 allow any number of insertions or deletions. Default value: 1. |
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
252 |
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
253 ATTRIBUTES_TO_RETAIN=String Reserved alignment attributes (tags starting with X, Y, or Z) that should be brought over |
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
254 from the alignment data when merging. This option may be specified 0 or more times. |
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
255 |
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
256 ATTRIBUTES_TO_REMOVE=String Attributes from the alignment record that should be removed when merging. This overrides |
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
257 ATTRIBUTES_TO_RETAIN if they share common tags. This option may be specified 0 or more |
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
258 times. |
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
259 |
5 | 260 READ1_TRIM=Integer |
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
261 R1_TRIM=Integer The number of bases trimmed from the beginning of read 1 prior to alignment Default |
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
262 value: 0. |
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
263 |
5 | 264 READ2_TRIM=Integer |
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
265 R2_TRIM=Integer The number of bases trimmed from the beginning of read 2 prior to alignment Default |
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
266 value: 0. |
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
267 |
5 | 268 EXPECTED_ORIENTATIONS=PairOrientation |
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
269 ORIENTATIONS=PairOrientation The expected orientation of proper read pairs. Replaces JUMP_SIZE Possible values: {FR, |
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
270 RF, TANDEM} This option may be specified 0 or more times. Cannot be used in conjuction |
5 | 271 with option(s) JUMP_SIZE (JUMP) |
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
272 |
5 | 273 ALIGNER_PROPER_PAIR_FLAGS=Boolean |
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
274 Use the aligner's idea of what a proper pair is rather than computing in this program. |
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
275 Default value: false. 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
|
276 |
5 | 277 SORT_ORDER=SortOrder |
278 SO=SortOrder The order in which the merged reads should be output. Default value: coordinate. | |
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
279 Possible values: {unsorted, queryname, coordinate} |
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
280 |
5 | 281 PRIMARY_ALIGNMENT_STRATEGY=PrimaryAlignmentStrategy |
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
282 Strategy for selecting primary alignment when the aligner has provided more than one |
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
283 alignment for a pair or fragment, and none are marked as primary, more than one is marked |
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
284 as primary, or the primary alignment is filtered out for some reason. BestMapq expects |
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
285 that multiple alignments will be correlated with HI tag, and prefers the pair of |
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
286 alignments with the largest MAPQ, in the absence of a primary selected by the aligner. |
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
287 EarliestFragment prefers the alignment which maps the earliest base in the read. Note |
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
288 that EarliestFragment may not be used for paired reads. BestEndMapq is appropriate for |
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
289 cases in which the aligner is not pair-aware, and does not output the HI tag. It simply |
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
290 picks the alignment for each end with the highest MAPQ, and makes those alignments |
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
291 primary, regardless of whether the two alignments make sense together.MostDistant is also |
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
292 for a non-pair-aware aligner, and picks the alignment pair with the largest insert size. |
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
293 If all alignments would be chimeric, it picks the alignments for each end with the best |
5 | 294 MAPQ. For all algorithms, ties are resolved arbitrarily. Default value: BestMapq. |
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
295 Possible values: {BestMapq, EarliestFragment, BestEndMapq, MostDistant} |
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
296 |
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
297 CLIP_OVERLAPPING_READS=BooleanFor paired reads, soft clip the 3' end of each read if necessary so that it does not |
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
298 extend past the 5' end of its mate. Default value: true. 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
|
299 |
5 | 300 INCLUDE_SECONDARY_ALIGNMENTS=Boolean |
301 If false, do not write secondary alignments to output. Default value: true. | |
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
302 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
|
303 |
5 | 304 ADD_MATE_CIGAR=Boolean |
13
7e6fd3d0f16e
planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/picard commit bf94a1505c131fb3f67c867b6e1d886780efa42e
devteam
parents:
12
diff
changeset
|
305 MC=Boolean Adds the mate CIGAR tag (MC) if true, does not if false. Possible values: {true, false} |
5 | 306 |
307 | |
308 | |
309 | |
310 @more_info@ | |
311 </help> | |
19
5053a18d9bc8
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/picard commit 7036343b9ac0a0ffc2ce4f6db465b9298ef05e73
iuc
parents:
13
diff
changeset
|
312 <expand macro="citations" /> |
5 | 313 </tool> |