annotate leftalign.xml @ 0:c6a25d782353 draft

Uploaded first version
author anton
date Fri, 04 Apr 2014 15:57:19 -0400
parents
children 932378b3f1d9
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
1 <?xml version="1.0"?>
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
2 <tool id="leftalign" name="LeftAlign" version="0.0.1">
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
3 <requirements>
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
4 <requirement type="package" version="0.9.6_9608597d12e127c847ae03aa03440ab63992fedf">freebayes</requirement>
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
5 <requirement type="package" version="0.1.18">samtools</requirement>
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
6 </requirements>
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
7 <description> - leftaligner</description>
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
8 <command>
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
9 ##set up input files
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
10 #set $reference_fasta_filename = "localref.fa"
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
11 #if str( $reference_source.reference_source_selector ) == "history":
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
12 ln -s "${reference_source.ref_file}" "${reference_fasta_filename}" &amp;&amp;
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
13 samtools faidx "${reference_fasta_filename}" 2&gt;&amp;1 || echo "Error running samtools faidx for leftalign" &gt;&amp;2 &amp;&amp;
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
14 #else:
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
15 #set $reference_fasta_filename = str( $reference_source.ref_file.fields.path )
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
16 #end if
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
17
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
18 ##finished setting up inputs
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
19
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
20 ##start leftalign commandline
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
21 samtools view -bh "${input_bam}" | bamleftalign
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
22 --fasta-reference "${reference_fasta_filename}"
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
23 -c
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
24 --max-iterations "${iterations}"
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
25 ##outputs
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
26 > "${output_bam}"
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
27 </command>
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
28 <inputs>
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
29 <conditional name="reference_source">
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
30 <param name="reference_source_selector" type="select" label="Choose the source for the reference list">
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
31 <option value="cached">Locally cached</option>
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
32 <option value="history">History</option>
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
33 </param>
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
34 <when value="cached">
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
35 <param name="input_bam" type="data" format="bam" label="BAM file">
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
36 <validator type="unspecified_build" />
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
37 <validator type="dataset_metadata_in_data_table" table_name="sam_fa_indexes" metadata_name="dbkey" metadata_column="1" message="Sequences are not currently available for the specified build." />
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
38 </param>
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
39 <param name="ref_file" type="select" label="Using reference genome">
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
40 <options from_data_table="sam_fa_indexes">
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
41 <!--<filter type="data_meta" key="dbkey" ref="input_bam" column="value"/>-->
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
42 </options>
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
43 <validator type="no_options" message="A built-in reference genome is not available for the build associated with the selected input file"/>
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
44 </param>
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
45 </when>
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
46 <when value="history"> <!-- FIX ME!!!! -->
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
47 <param name="input_bam" type="data" format="bam" label="BAM file" />
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
48 <param name="ref_file" type="data" format="fasta" label="Using reference file" />
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
49 </when>
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
50 </conditional>
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
51 <param name="iterations" type="integer" size="3" value="5" label="Maximum number of iterations" help="Iterate the left-realignment no more than this many times" />
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
52 </inputs>
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
53 <outputs>
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
54 <data format="bam" name="output_bam" label="${tool.name} on ${on_string} (alignments)" />
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
55 </outputs>
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
56 <tests>
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
57 <test>
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
58 <param name="reference_source_selector" value="history" />
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
59 <param name="ref_file" ftype="fasta" value="leftalign.fa"/>
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
60 <param name="input_bam" ftype="bam" value="left-align-input.bam"/>
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
61 <param name="iterations" value="5"/>
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
62 <output name="output_bam" file="left-align-output.bam" />
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
63 </test>
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
64 </tests>
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
65 <stdio>
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
66 <exit_code range="1:" />
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
67 </stdio>
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
68 <help>
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
69
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
70 This is leftalign utility from FreeBayes package developed and maintained by Erik Garrison (https://github.com/ekg/freebayes).
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
71
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
72 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.
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
73
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
74 </help>
c6a25d782353 Uploaded first version
anton
parents:
diff changeset
75 </tool>