annotate leftalign.xml @ 0:5af352c58c24 draft default tip

Uploaded
author dave
date Wed, 02 Oct 2019 09:26:15 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
5af352c58c24 Uploaded
dave
parents:
diff changeset
1 <?xml version="1.0"?>
5af352c58c24 Uploaded
dave
parents:
diff changeset
2 <tool id="bamleftalign" name="BamLeftAlign" version="@DEPENDENCY_VERSION@">
5af352c58c24 Uploaded
dave
parents:
diff changeset
3 <description> indels in BAM datasets</description>
5af352c58c24 Uploaded
dave
parents:
diff changeset
4 <macros>
5af352c58c24 Uploaded
dave
parents:
diff changeset
5 <import>macros.xml</import>
5af352c58c24 Uploaded
dave
parents:
diff changeset
6 </macros>
5af352c58c24 Uploaded
dave
parents:
diff changeset
7 <expand macro="requirements" />
5af352c58c24 Uploaded
dave
parents:
diff changeset
8 <command detect_errors="exit_code"><![CDATA[
5af352c58c24 Uploaded
dave
parents:
diff changeset
9 ##set up input files
5af352c58c24 Uploaded
dave
parents:
diff changeset
10 #set $reference_fasta_filename = "localref.fa"
5af352c58c24 Uploaded
dave
parents:
diff changeset
11 #if str( $reference_source.reference_source_selector ) == "history":
5af352c58c24 Uploaded
dave
parents:
diff changeset
12 ln -s '${reference_source.ref_file}' '${reference_fasta_filename}' &&
5af352c58c24 Uploaded
dave
parents:
diff changeset
13 samtools faidx "${reference_fasta_filename}" 2>&1 || echo "Error running samtools faidx for leftalign" >&2 &&
5af352c58c24 Uploaded
dave
parents:
diff changeset
14 #else:
5af352c58c24 Uploaded
dave
parents:
diff changeset
15 #set $reference_fasta_filename = str( $reference_source.ref_file.fields.path )
5af352c58c24 Uploaded
dave
parents:
diff changeset
16 #end if
5af352c58c24 Uploaded
dave
parents:
diff changeset
17
5af352c58c24 Uploaded
dave
parents:
diff changeset
18 ##start leftalign commandline
5af352c58c24 Uploaded
dave
parents:
diff changeset
19 cat '${input_bam}' |
5af352c58c24 Uploaded
dave
parents:
diff changeset
20 bamleftalign
5af352c58c24 Uploaded
dave
parents:
diff changeset
21 --fasta-reference '${reference_fasta_filename}'
5af352c58c24 Uploaded
dave
parents:
diff changeset
22 -c
5af352c58c24 Uploaded
dave
parents:
diff changeset
23 --max-iterations "${iterations}"
5af352c58c24 Uploaded
dave
parents:
diff changeset
24 > '${output_bam}'
5af352c58c24 Uploaded
dave
parents:
diff changeset
25 ]]></command>
5af352c58c24 Uploaded
dave
parents:
diff changeset
26 <inputs>
5af352c58c24 Uploaded
dave
parents:
diff changeset
27 <conditional name="reference_source">
5af352c58c24 Uploaded
dave
parents:
diff changeset
28 <param name="reference_source_selector" type="select" label="Choose the source for the reference genome">
5af352c58c24 Uploaded
dave
parents:
diff changeset
29 <option value="cached">Locally cached</option>
5af352c58c24 Uploaded
dave
parents:
diff changeset
30 <option value="history">History</option>
5af352c58c24 Uploaded
dave
parents:
diff changeset
31 </param>
5af352c58c24 Uploaded
dave
parents:
diff changeset
32 <when value="cached">
5af352c58c24 Uploaded
dave
parents:
diff changeset
33 <param name="input_bam" type="data" format="bam" label="Select alignment file in BAM format">
5af352c58c24 Uploaded
dave
parents:
diff changeset
34 <validator type="unspecified_build" />
5af352c58c24 Uploaded
dave
parents:
diff changeset
35 <validator type="dataset_metadata_in_data_table" table_name="fasta_indexes" metadata_name="dbkey"
5af352c58c24 Uploaded
dave
parents:
diff changeset
36 metadata_column="1" message="Sequences are not currently available for the specified build." />
5af352c58c24 Uploaded
dave
parents:
diff changeset
37 </param>
5af352c58c24 Uploaded
dave
parents:
diff changeset
38 <param name="ref_file" type="select" label="Using reference genome" argument="--fasta-reference">
5af352c58c24 Uploaded
dave
parents:
diff changeset
39 <options from_data_table="fasta_indexes"></options>
5af352c58c24 Uploaded
dave
parents:
diff changeset
40 <validator type="no_options" message="A built-in reference genome is not available for the build associated with the selected input file"/>
5af352c58c24 Uploaded
dave
parents:
diff changeset
41 </param>
5af352c58c24 Uploaded
dave
parents:
diff changeset
42 </when>
5af352c58c24 Uploaded
dave
parents:
diff changeset
43 <when value="history">
5af352c58c24 Uploaded
dave
parents:
diff changeset
44 <param name="input_bam" type="data" format="bam" label="BAM dataset to re-align" />
5af352c58c24 Uploaded
dave
parents:
diff changeset
45 <param name="ref_file" type="data" format="fasta" label="Using reference file" argument="--fasta-reference" />
5af352c58c24 Uploaded
dave
parents:
diff changeset
46 </when>
5af352c58c24 Uploaded
dave
parents:
diff changeset
47 </conditional>
5af352c58c24 Uploaded
dave
parents:
diff changeset
48 <param name="iterations" type="integer" value="5" label="Maximum number of iterations"
5af352c58c24 Uploaded
dave
parents:
diff changeset
49 help="Iterate the left-realignment no more than this many times" argument="--max-iterations" />
5af352c58c24 Uploaded
dave
parents:
diff changeset
50 </inputs>
5af352c58c24 Uploaded
dave
parents:
diff changeset
51 <outputs>
5af352c58c24 Uploaded
dave
parents:
diff changeset
52 <data format="bam" name="output_bam" label="${tool.name} on ${on_string} (alignments)" />
5af352c58c24 Uploaded
dave
parents:
diff changeset
53 </outputs>
5af352c58c24 Uploaded
dave
parents:
diff changeset
54 <tests>
5af352c58c24 Uploaded
dave
parents:
diff changeset
55 <test>
5af352c58c24 Uploaded
dave
parents:
diff changeset
56 <param name="reference_source_selector" value="history" />
5af352c58c24 Uploaded
dave
parents:
diff changeset
57 <param name="ref_file" ftype="fasta" value="leftalign.fa"/>
5af352c58c24 Uploaded
dave
parents:
diff changeset
58 <param name="input_bam" ftype="bam" value="left-align-input.bam"/>
5af352c58c24 Uploaded
dave
parents:
diff changeset
59 <param name="iterations" value="5"/>
5af352c58c24 Uploaded
dave
parents:
diff changeset
60 <output name="output_bam" file="left-align-output.bam" />
5af352c58c24 Uploaded
dave
parents:
diff changeset
61 </test>
5af352c58c24 Uploaded
dave
parents:
diff changeset
62 </tests>
5af352c58c24 Uploaded
dave
parents:
diff changeset
63 <help>
5af352c58c24 Uploaded
dave
parents:
diff changeset
64
5af352c58c24 Uploaded
dave
parents:
diff changeset
65 When calling indels, it is important to homogenize the positional distribution of insertions and deletions in the input by using left realignment. Left realignment will place all indels in homopolymer and microsatellite repeats at the same position, provided that doing so does not introduce mismatches between the read and reference other than the indel. This method is computationally inexpensive and handles the most common classes of alignment inconsistency.
5af352c58c24 Uploaded
dave
parents:
diff changeset
66
5af352c58c24 Uploaded
dave
parents:
diff changeset
67 This is leftalign utility from FreeBayes package.
5af352c58c24 Uploaded
dave
parents:
diff changeset
68 </help>
5af352c58c24 Uploaded
dave
parents:
diff changeset
69 <expand macro="citations" />
5af352c58c24 Uploaded
dave
parents:
diff changeset
70 </tool>