annotate indel_realigner.xml @ 15:01ff8dd37d4d draft default tip

Uploaded
author lz_hust
date Sat, 01 Jun 2019 07:20:41 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
15
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
1 <tool id="gatk2_indel_realigner" name="Indel Realigner" version="@VERSION@.1">
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
2 <description>- perform local realignment</description>
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
3 <macros>
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
4 <import>gatk2_macros.xml</import>
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
5 </macros>
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
6 <expand macro="requirements" />
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
7 <expand macro="version_command" />
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
8 <command interpreter="python">
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
9 gatk2_wrapper.py
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
10 --stdout "${output_log}"
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
11 -d "-I" "${reference_source.input_bam}" "${reference_source.input_bam.ext}" "gatk_input"
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
12 #if str( $reference_source.input_bam.metadata.bam_index ) != "None":
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
13 -d "" "${reference_source.input_bam.metadata.bam_index}" "bam_index" "gatk_input" ##hardcode galaxy ext type as bam_index
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
14 #end if
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
15 -p '
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
16 @JAR_PATH@
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
17 -T "IndelRealigner"
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
18 -o "${output_bam}"
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
19
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
20 \$GATK2_SITE_OPTIONS
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
21
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
22 ## according to http://www.broadinstitute.org/gatk/guide/article?id=1975
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
23 --num_cpu_threads_per_data_thread 1
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
24
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
25 #if $reference_source.reference_source_selector != "history":
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
26 -R "${reference_source.ref_file.fields.path}"
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
27 #end if
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
28 -LOD "${lod_threshold}"
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
29 ${knowns_only}
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
30 '
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
31
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
32 #set $rod_binding_names = dict()
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
33 #for $rod_binding in $rod_bind:
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
34 #if str( $rod_binding.rod_bind_type.rod_bind_type_selector ) == 'custom':
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
35 #set $rod_bind_name = $rod_binding.rod_bind_type.custom_rod_name
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
36 #else
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
37 #set $rod_bind_name = $rod_binding.rod_bind_type.rod_bind_type_selector
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
38 #end if
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
39 #set $rod_binding_names[$rod_bind_name] = $rod_binding_names.get( $rod_bind_name, -1 ) + 1
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
40 -d "-known:${rod_bind_name},%(file_type)s" "${rod_binding.rod_bind_type.input_rod}" "${rod_binding.rod_bind_type.input_rod.ext}" "input_${rod_bind_name}_${rod_binding_names[$rod_bind_name]}"
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
41 #end for
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
42
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
43 $allow_n_cigar_reads
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
44 #include source=$standard_gatk_options#
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
45 ##start analysis specific options
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
46 -d "-targetIntervals" "${target_intervals}" "${target_intervals.ext}" "gatk_target_intervals"
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
47 -p '
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
48 --disable_bam_indexing
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
49 '
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
50 #if $analysis_param_type.analysis_param_type_selector == "advanced":
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
51 -p '
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
52 --entropyThreshold "${analysis_param_type.entropy_threshold}"
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
53 ${analysis_param_type.simplify_bam}
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
54 --consensusDeterminationModel "${analysis_param_type.consensus_determination_model}"
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
55 --maxIsizeForMovement "${analysis_param_type.max_insert_size_for_movement}"
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
56 --maxPositionalMoveAllowed "${analysis_param_type.max_positional_move_allowed}"
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
57 --maxConsensuses "${analysis_param_type.max_consensuses}"
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
58 --maxReadsForConsensuses "${analysis_param_type.max_reads_for_consensuses}"
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
59 --maxReadsForRealignment "${analysis_param_type.max_reads_for_realignment}"
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
60 ${analysis_param_type.no_original_alignment_tags}
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
61 '
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
62 #end if
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
63 </command>
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
64 <inputs>
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
65
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
66 <conditional name="reference_source">
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
67 <expand macro="reference_source_selector_param" />
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
68 <when value="cached">
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
69 <param name="input_bam" type="data" format="bam" label="BAM file" help="-I,--input_file &amp;lt;input_file&amp;gt;">
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
70 <validator type="unspecified_build" />
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
71 <validator type="dataset_metadata_in_data_table" table_name="gatk2_picard_indexes" metadata_name="dbkey" metadata_column="dbkey" message="Sequences are not currently available for the specified build." /> <!-- fixme!!! this needs to be a select -->
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
72 </param>
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
73 <param name="ref_file" type="select" label="Using reference genome" help="-R,--reference_sequence &amp;lt;reference_sequence&amp;gt;" >
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
74 <options from_data_table="gatk2_picard_indexes">
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
75 <filter type="data_meta" key="dbkey" ref="input_bam" column="dbkey"/>
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
76 </options>
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
77 <validator type="no_options" message="A built-in reference genome is not available for the build associated with the selected input file"/>
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
78 </param>
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
79 </when>
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
80 <when value="history">
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
81 <param name="input_bam" type="data" format="bam" label="BAM file" help="-I,--input_file &amp;lt;input_file&amp;gt;" />
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
82 <param name="ref_file" type="data" format="fasta" label="Using reference file" help="-R,--reference_sequence &amp;lt;reference_sequence&amp;gt;">
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
83 <options>
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
84 <filter type="data_meta" key="dbkey" ref="input_bam" />
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
85 </options>
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
86 </param>
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
87 </when>
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
88 </conditional>
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
89 <param name="target_intervals" type="data" format="gatk_interval,bed,picard_interval_list" label="Restrict realignment to provided intervals" help="-targetIntervals,--targetIntervals &amp;lt;targetIntervals&amp;gt;" />
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
90 <repeat name="rod_bind" title="Known Variants" help="Using data sets of known variants (-known,--knownAlleles &amp;lt;knownAlleles&amp;gt;)">
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
91 <conditional name="rod_bind_type">
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
92 <param name="rod_bind_type_selector" type="select" label="Variant Type">
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
93 <option value="dbsnp" selected="True">dbSNP</option>
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
94 <option value="snps">SNPs</option>
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
95 <option value="indels">INDELs</option>
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
96 <option value="custom">Custom</option>
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
97 </param>
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
98 <when value="dbsnp">
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
99 <param name="input_rod" type="data" format="vcf" label="Variant file (VCF format)" />
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
100 </when>
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
101 <when value="snps">
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
102 <param name="input_rod" type="data" format="vcf" label="Variant file (VCF format)" />
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
103 </when>
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
104 <when value="indels">
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
105 <param name="input_rod" type="data" format="vcf" label="Variant file (VCF format)" />
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
106 </when>
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
107 <when value="custom">
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
108 <param name="custom_rod_name" type="text" value="Unknown" label="Customer's variant file"/>
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
109 <param name="input_rod" type="data" format="vcf" label="Variant file (VCF format)" />
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
110 </when>
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
111 </conditional>
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
112 </repeat>
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
113 <param name="lod_threshold" type="float" value="5.0" label="LOD threshold above which the realigner will proceed to realign" help="-LOD,--LODThresholdForCleaning &amp;lt;LODThresholdForCleaning&amp;gt;" />
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
114 <param name="knowns_only" type="boolean" checked="False" truevalue="-knownsOnly" falsevalue="" label="Use only known indels provided as RODs" help="-knownsOnly"/>
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
115
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
116 <expand macro="allow_n_cigar_reads" />
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
117 <expand macro="gatk_param_type_conditional" />
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
118
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
119 <expand macro="analysis_type_conditional">
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
120
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
121 <param name="entropy_threshold" type="float" value="0.15" label="percentage of mismatching base quality scores at a position to be considered having high entropy" help="-entropy,--entropyThreshold &amp;lt;entropyThreshold&amp;gt;" />
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
122 <param name="simplify_bam" type="boolean" checked="False" truevalue="-simplifyBAM" falsevalue="" label="Simplify BAM" help="-simplifyBAM,--simplifyBAM"/>
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
123 <param name="consensus_determination_model" type="select" label="Consensus Determination Model" help="-model,--consensusDeterminationModel &amp;lt;consensusDeterminationModel&amp;gt;">
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
124 <option value="KNOWNS_ONLY">KNOWNS_ONLY</option>
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
125 <option value="USE_READS" selected="True">USE_READS</option>
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
126 <option value="USE_SW">USE_SW</option>
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
127 </param>
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
128 <param name="max_insert_size_for_movement" type="integer" value="3000" label="Maximum insert size of read pairs that we attempt to realign" help="-maxIsize,--maxIsizeForMovement &amp;lt;maxIsizeForMovement&amp;gt;" />
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
129 <param name="max_positional_move_allowed" type="integer" value="200" label="Maximum positional move in basepairs that a read can be adjusted during realignment" help="-maxPosMove,--maxPositionalMoveAllowed &amp;lt;maxPositionalMoveAllowed&amp;gt;" />
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
130 <param name="max_consensuses" type="integer" value="30" label="Max alternate consensuses to try" help="-maxConsensuses,--maxConsensuses &amp;lt;maxConsensuses&amp;gt;" />
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
131 <param name="max_reads_for_consensuses" type="integer" value="120" label="Max reads (chosen randomly) used for finding the potential alternate consensuses" help="-greedy,--maxReadsForConsensuses &amp;lt;maxReadsForConsensuses&amp;gt;" />
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
132 <param name="max_reads_for_realignment" type="integer" value="20000" label="Max reads allowed at an interval for realignment" help="-maxReads,--maxReadsForRealignment &amp;lt;maxReadsForRealignment&amp;gt;" />
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
133 <param name="no_original_alignment_tags" type="boolean" checked="False" truevalue="--noOriginalAlignmentTags" falsevalue="" label="Don't output the original cigar or alignment start tags for each realigned read in the output bam" help="-noTags,--noOriginalAlignmentTags"/>
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
134 </expand>
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
135 </inputs>
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
136 <outputs>
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
137 <data format="bam" name="output_bam" label="${tool.name} on ${on_string} (BAM)" />
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
138 <data format="txt" name="output_log" label="${tool.name} on ${on_string} (log)" />
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
139 </outputs>
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
140 <tests>
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
141 <test>
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
142 <param name="reference_source_selector" value="history" />
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
143 <param name="ref_file" value="phiX.fasta" ftype="fasta" />
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
144 <param name="target_intervals" value="gatk/gatk_realigner_target_creator/gatk_realigner_target_creator_out_1.gatk_interval" ftype="gatk_interval" />
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
145 <param name="input_bam" value="gatk/fake_phiX_reads_1.bam" ftype="bam" />
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
146 <param name="rod_bind_type_selector" value="snps" />
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
147 <param name="input_rod" value="gatk/fake_phiX_variant_locations.vcf" ftype="vcf" />
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
148 <param name="lod_threshold" value="5.0" />
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
149 <param name="knowns_only" />
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
150 <param name="gatk_param_type_selector" value="basic" />
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
151 <param name="analysis_param_type_selector" value="advanced" />
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
152 <param name="entropy_threshold" value="0.15" />
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
153 <param name="simplify_bam" />
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
154 <param name="consensus_determination_model" value="USE_SW" />
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
155 <param name="max_insert_size_for_movement" value="3000" />
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
156 <param name="max_positional_move_allowed" value="200" />
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
157 <param name="max_consensuses" value="30" />
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
158 <param name="max_reads_for_consensuses" value="120" />
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
159 <param name="max_reads_for_realignment" value="20000" />
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
160 <param name="no_original_alignment_tags" />
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
161 <output name="output_bam" file="gatk/gatk_indel_realigner/gatk_indel_realigner_out_1.bam" ftype="bam" lines_diff="2" />
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
162 <output name="output_log" file="gatk/gatk_indel_realigner/gatk_indel_realigner_out_1.log.contains" compare="contains" />
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
163 </test>
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
164 </tests>
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
165 <help>
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
166 **What it does**
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
167
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
168 Performs local realignment of reads based on misalignments due to the presence of indels. Unlike most mappers, this walker uses the full alignment context to determine whether an appropriate alternate reference (i.e. indel) exists and updates SAMRecords accordingly.
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
169
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
170 For more information on local realignment around indels using the GATK, see this `tool specific page &lt;http://www.broadinstitute.org/gatk/gatkdocs/org_broadinstitute_sting_gatk_walkers_indels_IndelRealigner.html&gt;`_.
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
171
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
172 To learn about best practices for variant detection using GATK, see this `overview &lt;http://www.broadinstitute.org/gatk/guide/topic?name=best-practices&gt;`_.
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
173
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
174 If you encounter errors, please view the `GATK FAQ &lt;http://www.broadinstitute.org/gatk/guide/topic?name=faqs&gt;`_.
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
175
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
176 ------
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
177
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
178 **Inputs**
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
179
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
180 GenomeAnalysisTK: IndelRealigner accepts an aligned BAM and a list of intervals to realign as input files.
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
181
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
182
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
183 **Outputs**
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
184
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
185 The output is in the BAM format.
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
186
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
187
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
188 Go `here &lt;http://www.broadinstitute.org/gatk/guide/topic?name=intro&gt;`_ for details on GATK file formats.
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
189
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
190 -------
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
191
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
192 **Settings**::
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
193
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
194 targetIntervals intervals file output from RealignerTargetCreator
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
195 LODThresholdForCleaning LOD threshold above which the cleaner will clean
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
196 entropyThreshold percentage of mismatches at a locus to be considered having high entropy
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
197 out Output bam
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
198 bam_compression Compression level to use for writing BAM files
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
199 disable_bam_indexing Turn off on-the-fly creation of indices for output BAM files.
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
200 simplifyBAM If provided, output BAM files will be simplified to include just key reads for downstream variation discovery analyses (removing duplicates, PF-, non-primary reads), as well stripping all extended tags from the kept reads except the read group identifier
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
201 useOnlyKnownIndels Don't run 'Smith-Waterman' to generate alternate consenses; use only known indels provided as RODs for constructing the alternate references.
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
202 maxReadsInMemory max reads allowed to be kept in memory at a time by the SAMFileWriter. Keep it low to minimize memory consumption (but the tool may skip realignment on regions with too much coverage. If it is too low, it may generate errors during realignment); keep it high to maximize realignment (but make sure to give Java enough memory).
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
203 maxIsizeForMovement maximum insert size of read pairs that we attempt to realign
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
204 maxPositionalMoveAllowed maximum positional move in basepairs that a read can be adjusted during realignment
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
205 maxConsensuses max alternate consensuses to try (necessary to improve performance in deep coverage)
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
206 maxReadsForConsensuses max reads used for finding the alternate consensuses (necessary to improve performance in deep coverage)
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
207 maxReadsForRealignment max reads allowed at an interval for realignment; if this value is exceeded, realignment is not attempted and the reads are passed to the output file(s) as-is
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
208 noOriginalAlignmentTags Don't output the original cigar or alignment start tags for each realigned read in the output bam.
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
209
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
210 @CITATION_SECTION@
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
211 </help>
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
212 <expand macro="citations" />
01ff8dd37d4d Uploaded
lz_hust
parents:
diff changeset
213 </tool>