annotate mafft-add.xml @ 11:f1a5908ea2cb draft

"planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit 9323ee4de558166899cebdb799e716cdb4a40a1e"
author bgruening
date Mon, 01 Nov 2021 09:49:39 +0000
parents aaefa93c2dd2
children 6f28e90db932
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
1 <?xml version="1.0" encoding="UTF-8"?>
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
2 <tool id="rbc_mafft_add" name="MAFFT add" version="@TOOL_VERSION@+galaxy@VERSION@">
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
3 <description>Align a sequence,alignment or fragments to an existing alignment.</description>
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
4 <macros>
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
5 <import>macros.xml</import>
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
6 </macros>
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
7 <expand macro="requirements" />
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
8 <stdio>
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
9 <exit_code range="1:" level="fatal" description="Error occurred. Please check Tool Standard Error" />
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
10 <exit_code range=":-1" level="fatal" description="Error occurred. Please check Tool Standard Error" />
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
11 </stdio>
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
12 <version_command> <![CDATA[
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
13 mafft --version
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
14 ]]>
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
15 </version_command>
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
16 <command>
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
17 <![CDATA[
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
18 mafft
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
19 #if $sequences.sequenceType == 'singleseq'
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
20 $sequences.preservegap '$inputSequences'
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
21 #elif $sequences.sequenceType == 'frags'
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
22 --addfragments '$inputSequences'
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
23 #elif $sequences.sequenceType == 'group'
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
24 --addprofile '$inputSequences'
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
25 #end if
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
26 $keeplength $map $reorder
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
27 '$inputAlignment'
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
28 > '$outputAlignment'
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
29 #if $map == '--mapout'
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
30 && mv '${inputSequences}.map' '$outputmap'
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
31 #end if
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
32 ]]>
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
33 </command>
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
34 <inputs>
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
35 <param name="inputSequences" type="data" format="fasta" label="Sequences to add to the alignment" help="Amino acid or nucleotide sequences in FASTA format."/>
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
36 <param name="inputAlignment" type="data" format="fasta" label="Alignment" help="Amino acid or nucleotide sequences in aligned FASTA format."/>
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
37 <conditional name="sequences">
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
38 <param name="sequenceType" type="select" label="What do you want to add to the alignment" >
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
39 <option value="singleseq">A single sequence</option>
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
40 <option value="frags" selected="true">Fragments</option>
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
41 <option value="group">An alignment</option>
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
42 </param>
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
43 <when value='singleseq'>
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
44 <param name="preservegap" type="select" label="Preserve the original alignment" help="Keep the given alignment unchanged (--add .)If not, the aligned letters in the seed alignment are preserved but gaps are not necessarily preserved (--seed)">
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
45 <option value="--add" selected="true" >Yes</option>
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
46 <option value="--seed">no</option>
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
47 </param>
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
48 </when>
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
49 <when value='frags'/>
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
50 <when value='group'/>
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
51 </conditional>
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
52 <param name="keeplength" type="boolean" truevalue="--keeplength" falsevalue="" checked="True" label="Keep alignment length" help="The alignment length is unchanged. Insertions at the additional sequences are deleted" />
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
53 <param name="map" type="boolean" truevalue="--mapout" falsevalue="" checked="False" label="Output a correspondance table of positions (--mapout)" help="Output a correspondence table of positions, sequence.map, between before and after the calculation. The --mapout option automatically turns on the --keeplength option, to keep the numbering of sites in the reference alignment" />
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
54 <param name="reorder" type="boolean" truevalue="" falsevalue="--reorder" checked="True" label="Preserve the original order of sequences (--reorder)" />
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
55 </inputs>
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
56 <outputs>
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
57 <data format="fasta" name="outputAlignment" label="${tool.name} on ${on_string} : New alignment"/>
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
58 <data name="outputmap" format="tabular" label="${tool.name} on ${on_string} : Correspondance of positions ">
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
59 <filter>map == True</filter>
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
60 </data>
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
61 </outputs>
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
62 <tests>
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
63 <test expect_num_outputs="1" >
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
64 <param name="inputSequences" value="add_seq.fa"/>
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
65 <param name="inputAlignment" value="mafft_fftns_result.aln"/>
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
66 <param name="sequenceType" value="singleseq"/>
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
67 <param name="preservegap" value="--add"/>
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
68 <param name="keeplength" value="--keeplength"/>
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
69 <param name="map" value=""/>
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
70 <output name="outputAlignment" ftype="fasta" file="mafft_add_result.aln"/>
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
71 </test>
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
72 </tests>
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
73 <help>
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
74 <![CDATA[
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
75 Add one of more sequences to an existing alignment. The new sequence(s) can be complete, fragments, or another alignement.
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
76
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
77 - Sequences in new_sequences are ungapped and then aligned to existing_alignment.
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
78 - new_sequences is a single multi-FASTA format file.
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
79 - existing_alignment is a single multi-FASTA format file.
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
80 - Gaps in existing_alignment are preserved by default (--add), but it can be deactivated (--seed). In that case the aligned letters in the seed alignment are preserved but gaps are not necessarily preserved.
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
81 - The alignment length may be conserved if the --keeplength option is given. The alignment length is unchanged. Insertions at the new sequences are deleted.
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
82 - --mapout options output a correspondence table of positions, new_sequences.map, between before and after the calculation. The --mapout option automatically turns on the --keeplength option, to keep the numbering of sites in the reference alignment.
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
83 - Omit --reorder to preserve the original sequence order.
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
84
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
85 ]]>
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
86 </help>
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
87 <expand macro="citations" />
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
88 </tool>