annotate leftalign.xml @ 10:2fb16f415220 draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 99e8a87a2993ae644df15756044a40a42aa7a05b
author iuc
date Wed, 25 Oct 2017 08:29:29 -0400
parents c07ad8a9c701
children f14331392369
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3
9f3d6c3098ac planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
1 <?xml version="1.0"?>
10
2fb16f415220 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 99e8a87a2993ae644df15756044a40a42aa7a05b
iuc
parents: 9
diff changeset
2 <tool id="bamleftalign" name="BamLeftAlign" version="@DEPENDENCY_VERSION@-0">
4
c171daf263dd planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 3
diff changeset
3 <description> indels in BAM datasets</description>
6
3aacf7637e02 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents: 4
diff changeset
4 <macros>
3aacf7637e02 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents: 4
diff changeset
5 <import>macros.xml</import>
3aacf7637e02 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents: 4
diff changeset
6 </macros>
9
c07ad8a9c701 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 9bbda385129b4bc34f66889d28c2570bf5bb2214
iuc
parents: 6
diff changeset
7 <expand macro="requirements" />
c07ad8a9c701 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 9bbda385129b4bc34f66889d28c2570bf5bb2214
iuc
parents: 6
diff changeset
8 <command detect_errors="exit_code"><![CDATA[
4
c171daf263dd planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 3
diff changeset
9 ##set up input files
c171daf263dd planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 3
diff changeset
10 #set $reference_fasta_filename = "localref.fa"
c171daf263dd planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 3
diff changeset
11 #if str( $reference_source.reference_source_selector ) == "history":
6
3aacf7637e02 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents: 4
diff changeset
12 ln -s '${reference_source.ref_file}' '${reference_fasta_filename}' &&
3aacf7637e02 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents: 4
diff changeset
13 samtools faidx "${reference_fasta_filename}" 2>&1 || echo "Error running samtools faidx for leftalign" >&2 &&
4
c171daf263dd planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 3
diff changeset
14 #else:
c171daf263dd planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 3
diff changeset
15 #set $reference_fasta_filename = str( $reference_source.ref_file.fields.path )
c171daf263dd planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 3
diff changeset
16 #end if
3
9f3d6c3098ac planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
17
4
c171daf263dd planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 3
diff changeset
18 ##start leftalign commandline
6
3aacf7637e02 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents: 4
diff changeset
19 cat '${input_bam}' |
3aacf7637e02 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents: 4
diff changeset
20 bamleftalign
3aacf7637e02 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents: 4
diff changeset
21 --fasta-reference '${reference_fasta_filename}'
3aacf7637e02 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents: 4
diff changeset
22 -c
3aacf7637e02 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents: 4
diff changeset
23 --max-iterations "${iterations}"
3aacf7637e02 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents: 4
diff changeset
24 > '${output_bam}'
3aacf7637e02 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents: 4
diff changeset
25 ]]></command>
4
c171daf263dd planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 3
diff changeset
26 <inputs>
c171daf263dd planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 3
diff changeset
27 <conditional name="reference_source">
6
3aacf7637e02 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents: 4
diff changeset
28 <param name="reference_source_selector" type="select" label="Choose the source for the reference genome">
4
c171daf263dd planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 3
diff changeset
29 <option value="cached">Locally cached</option>
c171daf263dd planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 3
diff changeset
30 <option value="history">History</option>
3
9f3d6c3098ac planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
31 </param>
4
c171daf263dd planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 3
diff changeset
32 <when value="cached">
6
3aacf7637e02 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents: 4
diff changeset
33 <param name="input_bam" type="data" format="bam" label="Select alignment file in BAM format">
4
c171daf263dd planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 3
diff changeset
34 <validator type="unspecified_build" />
6
3aacf7637e02 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents: 4
diff changeset
35 <validator type="dataset_metadata_in_data_table" table_name="fasta_indexes" metadata_name="dbkey"
3aacf7637e02 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents: 4
diff changeset
36 metadata_column="1" message="Sequences are not currently available for the specified build." />
4
c171daf263dd planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 3
diff changeset
37 </param>
6
3aacf7637e02 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents: 4
diff changeset
38 <param name="ref_file" type="select" label="Using reference genome" argument="--fasta-reference">
4
c171daf263dd planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 3
diff changeset
39 <options from_data_table="fasta_indexes"></options>
c171daf263dd planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 3
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"/>
c171daf263dd planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 3
diff changeset
41 </param>
c171daf263dd planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 3
diff changeset
42 </when>
c171daf263dd planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 3
diff changeset
43 <when value="history">
c171daf263dd planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 3
diff changeset
44 <param name="input_bam" type="data" format="bam" label="BAM dataset to re-align" />
6
3aacf7637e02 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents: 4
diff changeset
45 <param name="ref_file" type="data" format="fasta" label="Using reference file" argument="--fasta-reference" />
4
c171daf263dd planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 3
diff changeset
46 </when>
c171daf263dd planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 3
diff changeset
47 </conditional>
6
3aacf7637e02 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents: 4
diff changeset
48 <param name="iterations" type="integer" value="5" label="Maximum number of iterations"
3aacf7637e02 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents: 4
diff changeset
49 help="Iterate the left-realignment no more than this many times" argument="--max-iterations" />
4
c171daf263dd planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 3
diff changeset
50 </inputs>
c171daf263dd planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 3
diff changeset
51 <outputs>
c171daf263dd planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 3
diff changeset
52 <data format="bam" name="output_bam" label="${tool.name} on ${on_string} (alignments)" />
c171daf263dd planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 3
diff changeset
53 </outputs>
c171daf263dd planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 3
diff changeset
54 <tests>
c171daf263dd planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 3
diff changeset
55 <test>
c171daf263dd planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 3
diff changeset
56 <param name="reference_source_selector" value="history" />
c171daf263dd planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 3
diff changeset
57 <param name="ref_file" ftype="fasta" value="leftalign.fa"/>
c171daf263dd planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 3
diff changeset
58 <param name="input_bam" ftype="bam" value="left-align-input.bam"/>
c171daf263dd planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 3
diff changeset
59 <param name="iterations" value="5"/>
c171daf263dd planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 3
diff changeset
60 <output name="output_bam" file="left-align-output.bam" />
c171daf263dd planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 3
diff changeset
61 </test>
c171daf263dd planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 3
diff changeset
62 </tests>
c171daf263dd planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 3
diff changeset
63 <help>
3
9f3d6c3098ac planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
64
9f3d6c3098ac planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
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.
9f3d6c3098ac planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
66
6
3aacf7637e02 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents: 4
diff changeset
67 This is leftalign utility from FreeBayes package.
4
c171daf263dd planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 3
diff changeset
68 </help>
6
3aacf7637e02 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents: 4
diff changeset
69 <expand macro="citations" />
3
9f3d6c3098ac planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
70 </tool>