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

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