annotate leftalign.xml @ 34:a7c9782130e8 draft

"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit be1c2e9e056710ef8b1110a121dc38c6e06dbbee"
author iuc
date Mon, 21 Feb 2022 09:53:39 +0000
parents 57def2d7c093
children a5937157062f
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"?>
31
57def2d7c093 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 3b5abd63372c2806870627e9dc2a2f0f52f2e52a"
iuc
parents: 30
diff changeset
2 <tool id="bamleftalign" name="BamLeftAlign" version="@TOOL_VERSION@">
23
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>
31
57def2d7c093 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 3b5abd63372c2806870627e9dc2a2f0f52f2e52a"
iuc
parents: 30
diff changeset
4 <xrefs>
57def2d7c093 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 3b5abd63372c2806870627e9dc2a2f0f52f2e52a"
iuc
parents: 30
diff changeset
5 <xref type="bio.tools">freebayes</xref>
57def2d7c093 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 3b5abd63372c2806870627e9dc2a2f0f52f2e52a"
iuc
parents: 30
diff changeset
6 </xrefs>
25
bf27106652f3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents: 23
diff changeset
7 <macros>
bf27106652f3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents: 23
diff changeset
8 <import>macros.xml</import>
bf27106652f3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents: 23
diff changeset
9 </macros>
28
977a5301b66d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 9bbda385129b4bc34f66889d28c2570bf5bb2214
iuc
parents: 25
diff changeset
10 <expand macro="requirements" />
34
a7c9782130e8 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit be1c2e9e056710ef8b1110a121dc38c6e06dbbee"
iuc
parents: 31
diff changeset
11 <expand macro="version_command" />
28
977a5301b66d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 9bbda385129b4bc34f66889d28c2570bf5bb2214
iuc
parents: 25
diff changeset
12 <command detect_errors="exit_code"><![CDATA[
23
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
13 ##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
14 #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
15 #if str( $reference_source.reference_source_selector ) == "history":
25
bf27106652f3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents: 23
diff changeset
16 ln -s '${reference_source.ref_file}' '${reference_fasta_filename}' &&
bf27106652f3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents: 23
diff changeset
17 samtools faidx "${reference_fasta_filename}" 2>&1 || echo "Error running samtools faidx for leftalign" >&2 &&
23
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
18 #else:
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
19 #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
20 #end if
16
6d9407020066 Uploaded
devteam
parents:
diff changeset
21
23
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
22 ##start leftalign commandline
25
bf27106652f3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents: 23
diff changeset
23 cat '${input_bam}' |
bf27106652f3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents: 23
diff changeset
24 bamleftalign
bf27106652f3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents: 23
diff changeset
25 --fasta-reference '${reference_fasta_filename}'
bf27106652f3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents: 23
diff changeset
26 -c
bf27106652f3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents: 23
diff changeset
27 --max-iterations "${iterations}"
bf27106652f3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents: 23
diff changeset
28 > '${output_bam}'
bf27106652f3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents: 23
diff changeset
29 ]]></command>
23
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
30 <inputs>
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
31 <conditional name="reference_source">
25
bf27106652f3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents: 23
diff changeset
32 <param name="reference_source_selector" type="select" label="Choose the source for the reference genome">
23
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
33 <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
34 <option value="history">History</option>
16
6d9407020066 Uploaded
devteam
parents:
diff changeset
35 </param>
23
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
36 <when value="cached">
25
bf27106652f3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents: 23
diff changeset
37 <param name="input_bam" type="data" format="bam" label="Select alignment file in BAM format">
23
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
38 <validator type="unspecified_build" />
25
bf27106652f3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents: 23
diff changeset
39 <validator type="dataset_metadata_in_data_table" table_name="fasta_indexes" metadata_name="dbkey"
bf27106652f3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents: 23
diff changeset
40 metadata_column="1" message="Sequences are not currently available for the specified build." />
23
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
41 </param>
25
bf27106652f3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents: 23
diff changeset
42 <param name="ref_file" type="select" label="Using reference genome" argument="--fasta-reference">
23
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>
30
ef2c525bd8cd "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 24f33bda62a7b6771ad42a39fe8c683e09f6d8b8"
iuc
parents: 29
diff changeset
47 <when value="history">
23
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" />
25
bf27106652f3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents: 23
diff changeset
49 <param name="ref_file" type="data" format="fasta" label="Using reference file" argument="--fasta-reference" />
23
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>
25
bf27106652f3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents: 23
diff changeset
52 <param name="iterations" type="integer" value="5" label="Maximum number of iterations"
bf27106652f3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents: 23
diff changeset
53 help="Iterate the left-realignment no more than this many times" argument="--max-iterations" />
23
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
54 </inputs>
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
55 <outputs>
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
56 <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
57 </outputs>
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
58 <tests>
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
59 <test>
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="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
61 <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
62 <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
63 <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
64 <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
65 </test>
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
66 </tests>
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
67 <help>
16
6d9407020066 Uploaded
devteam
parents:
diff changeset
68
6d9407020066 Uploaded
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.
6d9407020066 Uploaded
devteam
parents:
diff changeset
70
25
bf27106652f3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents: 23
diff changeset
71 This is leftalign utility from FreeBayes package.
23
52aed7d9ed2b planemo upload for repository https://github.com/galaxyproject/tools-devteam/tree/master/tools/freebayes commit cf4a70e780f104bc724323912b3b87fb37f887dd
devteam
parents: 21
diff changeset
72 </help>
25
bf27106652f3 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/freebayes commit 2bfbb5ae6b801e43355fdc3f964a5111fe3fe3a1
iuc
parents: 23
diff changeset
73 <expand macro="citations" />
16
6d9407020066 Uploaded
devteam
parents:
diff changeset
74 </tool>