annotate leftalign.xml @ 17:fcd4f3bf844e draft

"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 84c34980b4fd8454c1cc630be5d6a3c22a4a1ef3"
author iuc
date Sat, 07 May 2022 19:48:56 +0000
parents a2feedafda6f
children ed8508ec9613
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"?>
13
5031b6656a2b "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 3b5abd63372c2806870627e9dc2a2f0f52f2e52a"
iuc
parents: 12
diff changeset
2 <tool id="bamleftalign" name="BamLeftAlign" version="@TOOL_VERSION@">
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>
12
2667d6a97b50 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 11
diff changeset
4 <xrefs>
2667d6a97b50 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 11
diff changeset
5 <xref type="bio.tools">freebayes</xref>
2667d6a97b50 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 11
diff changeset
6 </xrefs>
6
3aacf7637e02 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents: 4
diff changeset
7 <macros>
3aacf7637e02 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents: 4
diff changeset
8 <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
9 </macros>
9
c07ad8a9c701 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 9bbda385129b4bc34f66889d28c2570bf5bb2214
iuc
parents: 6
diff changeset
10 <expand macro="requirements" />
16
a2feedafda6f "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit be1c2e9e056710ef8b1110a121dc38c6e06dbbee"
iuc
parents: 13
diff changeset
11 <expand macro="version_command" />
9
c07ad8a9c701 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 9bbda385129b4bc34f66889d28c2570bf5bb2214
iuc
parents: 6
diff changeset
12 <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
13 ##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
14 #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
15 #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
16 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
17 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
18 #else:
c171daf263dd planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 3
diff changeset
19 #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
20 #end if
3
9f3d6c3098ac planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
21
4
c171daf263dd planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 3
diff changeset
22 ##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
23 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
24 bamleftalign
3aacf7637e02 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents: 4
diff changeset
25 --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
26 -c
3aacf7637e02 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents: 4
diff changeset
27 --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
28 > '${output_bam}'
3aacf7637e02 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents: 4
diff changeset
29 ]]></command>
4
c171daf263dd planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 3
diff changeset
30 <inputs>
c171daf263dd planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 3
diff changeset
31 <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
32 <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
33 <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
34 <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
35 </param>
4
c171daf263dd planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 3
diff changeset
36 <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
37 <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
38 <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
39 <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
40 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
41 </param>
6
3aacf7637e02 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents: 4
diff changeset
42 <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
43 <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
44 <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
45 </param>
c171daf263dd planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 3
diff changeset
46 </when>
11
f14331392369 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 24f33bda62a7b6771ad42a39fe8c683e09f6d8b8"
iuc
parents: 10
diff changeset
47 <when value="history">
4
c171daf263dd planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 3
diff changeset
48 <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
49 <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
50 </when>
c171daf263dd planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 3
diff changeset
51 </conditional>
6
3aacf7637e02 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents: 4
diff changeset
52 <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
53 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
54 </inputs>
c171daf263dd planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 3
diff changeset
55 <outputs>
c171daf263dd planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 3
diff changeset
56 <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
57 </outputs>
c171daf263dd planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 3
diff changeset
58 <tests>
c171daf263dd planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 3
diff changeset
59 <test>
c171daf263dd planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 3
diff changeset
60 <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
61 <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
62 <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
63 <param name="iterations" value="5"/>
17
fcd4f3bf844e "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 84c34980b4fd8454c1cc630be5d6a3c22a4a1ef3"
iuc
parents: 16
diff changeset
64 <output name="output_bam" file="left-align-output.bam" ftype="bam" lines_diff="2" />
4
c171daf263dd planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 3
diff changeset
65 </test>
c171daf263dd planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 3
diff changeset
66 </tests>
c171daf263dd planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 3
diff changeset
67 <help>
3
9f3d6c3098ac planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
68
9f3d6c3098ac planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit 5a4e0ca9992af3a6e5ed2b533f04bb82ce761e0b
devteam
parents:
diff changeset
69 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
70
6
3aacf7637e02 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents: 4
diff changeset
71 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
72 </help>
6
3aacf7637e02 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents: 4
diff changeset
73 <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
74 </tool>