annotate leftalign.xml @ 23:52aed7d9ed2b draft

planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
author devteam
date Sun, 25 Sep 2016 09:48:24 -0400
parents 978760187fe2
children bf27106652f3
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
16
6d9407020066 Uploaded
devteam
parents:
diff changeset
1 <?xml version="1.0"?>
23
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
2 <tool id="bamleftalign" name="BamLeftAlign" version="1.0.2.29">
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
3 <description> indels in BAM datasets</description>
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
4 <requirements>
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
5 <requirement type="package" version="1.0.2.29">freebayes</requirement>
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
6 <requirement type="package" version="0.1.19">samtools</requirement>
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
7 </requirements>
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
8 <stdio>
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
9 <exit_code range="1:" />
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
10 </stdio>
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
11 <command>
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
12 ##set up input files
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
13 #set $reference_fasta_filename = "localref.fa"
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
14 #if str( $reference_source.reference_source_selector ) == "history":
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
15 ln -s "${reference_source.ref_file}" "${reference_fasta_filename}" &amp;&amp;
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
16 samtools faidx "${reference_fasta_filename}" 2&gt;&amp;1 || echo "Error running samtools faidx for leftalign" &gt;&amp;2 &amp;&amp;
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
17 #else:
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
18 #set $reference_fasta_filename = str( $reference_source.ref_file.fields.path )
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
19 #end if
16
6d9407020066 Uploaded
devteam
parents:
diff changeset
20
23
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
21 ##finished setting up inputs
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
22
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
23 ##start leftalign commandline
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
24 samtools view -bh "${input_bam}" | bamleftalign
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
25 --fasta-reference "${reference_fasta_filename}"
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
26 -c
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
27 --max-iterations "${iterations}"
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
28 ##outputs
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
29 > "${output_bam}"
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
30 </command>
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
31 <inputs>
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
32 <conditional name="reference_source">
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
33 <param name="reference_source_selector" type="select" label="Choose the source for the reference list">
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
34 <option value="cached">Locally cached</option>
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
35 <option value="history">History</option>
16
6d9407020066 Uploaded
devteam
parents:
diff changeset
36 </param>
23
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
37 <when value="cached">
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
38 <param name="input_bam" type="data" format="bam" label="Select BAM dataset to leftalign">
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
39 <validator type="unspecified_build" />
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
40 <validator type="dataset_metadata_in_data_table" table_name="fasta_indexes" metadata_name="dbkey" metadata_column="1" message="Sequences are not currently available for the specified build." />
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
41 </param>
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
42 <param name="ref_file" type="select" label="Using reference genome">
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
43 <options from_data_table="fasta_indexes"></options>
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
44 <validator type="no_options" message="A built-in reference genome is not available for the build associated with the selected input file"/>
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
45 </param>
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
46 </when>
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
47 <when value="history">
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
48 <param name="input_bam" type="data" format="bam" label="BAM dataset to re-align" />
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
49 <param name="ref_file" type="data" format="fasta" label="Using reference file" />
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
50 </when>
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
51 </conditional>
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
52 <param name="iterations" type="integer" value="5" label="Maximum number of iterations" help="Iterate the left-realignment no more than this many times" />
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
53 </inputs>
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
54 <outputs>
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
55 <data format="bam" name="output_bam" label="${tool.name} on ${on_string} (alignments)" />
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
56 </outputs>
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
57 <tests>
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
58 <test>
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
59 <param name="reference_source_selector" value="history" />
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
60 <param name="ref_file" ftype="fasta" value="leftalign.fa"/>
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
61 <param name="input_bam" ftype="bam" value="left-align-input.bam"/>
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
62 <param name="iterations" value="5"/>
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
63 <output name="output_bam" file="left-align-output.bam" />
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
64 </test>
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
65 </tests>
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
66 <help>
16
6d9407020066 Uploaded
devteam
parents:
diff changeset
67
6d9407020066 Uploaded
devteam
parents:
diff changeset
68 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.
6d9407020066 Uploaded
devteam
parents:
diff changeset
69
6d9407020066 Uploaded
devteam
parents:
diff changeset
70 This is leftalign utility from FreeBayes package developed and maintained by Erik Garrison (https://github.com/ekg/freebayes).
23
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
71 </help>
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
72 <citations>
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
73 <citation type="bibtex">
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
74 @misc{1207.3907,
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
75 Author = {Erik Garrison},
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
76 Title = {Haplotype-based variant detection from short-read sequencing},
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
77 Year = {2012},
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
78 Eprint = {arXiv:1207.3907},
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
79 url = {http://arxiv.org/abs/1207.3907}
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
80 }
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
81 </citation>
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
82 </citations>
16
6d9407020066 Uploaded
devteam
parents:
diff changeset
83 </tool>