annotate picard_MergeBamAlignment.xml @ 7:379fdf4c41ac draft

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