annotate mafft-add.xml @ 16:8e649f27aa0d draft default tip

planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit 3d98df472498e1273369d23822d10db14f337443
author bgruening
date Thu, 22 Aug 2024 19:20:24 +0000
parents bf28a8cff401
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
14
6f28e90db932 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit 1570f3a28232b4b88385cdfbb68f79d80ff1dabb
bgruening
parents: 7
diff changeset
1 <tool id="rbc_mafft_add" name="MAFFT add" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="@PROFILE@">
16
8e649f27aa0d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit 3d98df472498e1273369d23822d10db14f337443
bgruening
parents: 15
diff changeset
2 <description>Align a sequence,alignment or fragments to an existing alignment.</description>
8e649f27aa0d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit 3d98df472498e1273369d23822d10db14f337443
bgruening
parents: 15
diff changeset
3 <macros>
8e649f27aa0d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit 3d98df472498e1273369d23822d10db14f337443
bgruening
parents: 15
diff changeset
4 <import>macros.xml</import>
8e649f27aa0d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit 3d98df472498e1273369d23822d10db14f337443
bgruening
parents: 15
diff changeset
5 </macros>
8e649f27aa0d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit 3d98df472498e1273369d23822d10db14f337443
bgruening
parents: 15
diff changeset
6 <expand macro="biotools"/>
8e649f27aa0d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit 3d98df472498e1273369d23822d10db14f337443
bgruening
parents: 15
diff changeset
7 <expand macro="requirements"/>
8e649f27aa0d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit 3d98df472498e1273369d23822d10db14f337443
bgruening
parents: 15
diff changeset
8 <version_command>mafft --version</version_command>
8e649f27aa0d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit 3d98df472498e1273369d23822d10db14f337443
bgruening
parents: 15
diff changeset
9 <command detect_errors="exit_code">
7
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
10 <![CDATA[
15
bf28a8cff401 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit 2f6456c314c010fd73f5eeaf809a9afce47353af
bgruening
parents: 14
diff changeset
11 sh mk_symlinks.sh &&
7
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
12 mafft
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
13 #if $sequences.sequenceType == 'singleseq'
15
bf28a8cff401 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit 2f6456c314c010fd73f5eeaf809a9afce47353af
bgruening
parents: 14
diff changeset
14 $sequences.preservegap input_dir/sequence
7
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
15 #elif $sequences.sequenceType == 'frags'
15
bf28a8cff401 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit 2f6456c314c010fd73f5eeaf809a9afce47353af
bgruening
parents: 14
diff changeset
16 --addfragments input_dir/sequence
7
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
17 #elif $sequences.sequenceType == 'group'
15
bf28a8cff401 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit 2f6456c314c010fd73f5eeaf809a9afce47353af
bgruening
parents: 14
diff changeset
18 --addprofile input_dir/sequence
7
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
19 #end if
15
bf28a8cff401 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit 2f6456c314c010fd73f5eeaf809a9afce47353af
bgruening
parents: 14
diff changeset
20 $keeplength
bf28a8cff401 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit 2f6456c314c010fd73f5eeaf809a9afce47353af
bgruening
parents: 14
diff changeset
21 $mapout
bf28a8cff401 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit 2f6456c314c010fd73f5eeaf809a9afce47353af
bgruening
parents: 14
diff changeset
22 $reorder
bf28a8cff401 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit 2f6456c314c010fd73f5eeaf809a9afce47353af
bgruening
parents: 14
diff changeset
23 input_dir/alignment > '$outputAlignment'
bf28a8cff401 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit 2f6456c314c010fd73f5eeaf809a9afce47353af
bgruening
parents: 14
diff changeset
24
bf28a8cff401 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit 2f6456c314c010fd73f5eeaf809a9afce47353af
bgruening
parents: 14
diff changeset
25 #if $mapout
bf28a8cff401 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit 2f6456c314c010fd73f5eeaf809a9afce47353af
bgruening
parents: 14
diff changeset
26 && mv input_dir/sequence.map '$outputmap'
7
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
27 #end if
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
28 ]]>
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
29 </command>
16
8e649f27aa0d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit 3d98df472498e1273369d23822d10db14f337443
bgruening
parents: 15
diff changeset
30 <configfiles>
8e649f27aa0d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit 3d98df472498e1273369d23822d10db14f337443
bgruening
parents: 15
diff changeset
31 <configfile filename="mk_symlinks.sh"><![CDATA[
15
bf28a8cff401 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit 2f6456c314c010fd73f5eeaf809a9afce47353af
bgruening
parents: 14
diff changeset
32 mkdir input_dir &&
bf28a8cff401 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit 2f6456c314c010fd73f5eeaf809a9afce47353af
bgruening
parents: 14
diff changeset
33 ln -s '$inputSequences' input_dir/sequence &&
bf28a8cff401 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit 2f6456c314c010fd73f5eeaf809a9afce47353af
bgruening
parents: 14
diff changeset
34 ln -s '$inputAlignment' input_dir/alignment
bf28a8cff401 planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit 2f6456c314c010fd73f5eeaf809a9afce47353af
bgruening
parents: 14
diff changeset
35 ]]></configfile>
16
8e649f27aa0d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit 3d98df472498e1273369d23822d10db14f337443
bgruening
parents: 15
diff changeset
36 </configfiles>
8e649f27aa0d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit 3d98df472498e1273369d23822d10db14f337443
bgruening
parents: 15
diff changeset
37 <inputs>
8e649f27aa0d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit 3d98df472498e1273369d23822d10db14f337443
bgruening
parents: 15
diff changeset
38 <param name="inputSequences" type="data" format="fasta" label="Sequences to add to the alignment" help="Amino acid or nucleotide sequences in FASTA format."/>
8e649f27aa0d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit 3d98df472498e1273369d23822d10db14f337443
bgruening
parents: 15
diff changeset
39 <param name="inputAlignment" type="data" format="fasta" label="Alignment" help="Amino acid or nucleotide sequences in aligned FASTA format."/>
8e649f27aa0d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit 3d98df472498e1273369d23822d10db14f337443
bgruening
parents: 15
diff changeset
40 <conditional name="sequences">
8e649f27aa0d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit 3d98df472498e1273369d23822d10db14f337443
bgruening
parents: 15
diff changeset
41 <param name="sequenceType" type="select" label="What do you want to add to the alignment?">
8e649f27aa0d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit 3d98df472498e1273369d23822d10db14f337443
bgruening
parents: 15
diff changeset
42 <option value="singleseq">A single sequence</option>
8e649f27aa0d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit 3d98df472498e1273369d23822d10db14f337443
bgruening
parents: 15
diff changeset
43 <option value="frags" selected="true">Fragments</option>
8e649f27aa0d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit 3d98df472498e1273369d23822d10db14f337443
bgruening
parents: 15
diff changeset
44 <option value="group">An alignment</option>
8e649f27aa0d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit 3d98df472498e1273369d23822d10db14f337443
bgruening
parents: 15
diff changeset
45 </param>
8e649f27aa0d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit 3d98df472498e1273369d23822d10db14f337443
bgruening
parents: 15
diff changeset
46 <when value="singleseq">
8e649f27aa0d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit 3d98df472498e1273369d23822d10db14f337443
bgruening
parents: 15
diff changeset
47 <param name="preservegap" type="select" label="Preserve the original alignment." help="Keep the given alignment unchanged .If not, the aligned letters in the seed alignment are preserved but gaps are not necessarily preserved.">
8e649f27aa0d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit 3d98df472498e1273369d23822d10db14f337443
bgruening
parents: 15
diff changeset
48 <option value="--add" selected="true">Yes (--add)</option>
8e649f27aa0d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit 3d98df472498e1273369d23822d10db14f337443
bgruening
parents: 15
diff changeset
49 <option value="--seed">No (--seed)</option>
8e649f27aa0d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit 3d98df472498e1273369d23822d10db14f337443
bgruening
parents: 15
diff changeset
50 </param>
8e649f27aa0d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit 3d98df472498e1273369d23822d10db14f337443
bgruening
parents: 15
diff changeset
51 </when>
8e649f27aa0d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit 3d98df472498e1273369d23822d10db14f337443
bgruening
parents: 15
diff changeset
52 <when value="frags"/>
8e649f27aa0d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit 3d98df472498e1273369d23822d10db14f337443
bgruening
parents: 15
diff changeset
53 <when value="group"/>
8e649f27aa0d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit 3d98df472498e1273369d23822d10db14f337443
bgruening
parents: 15
diff changeset
54 </conditional>
8e649f27aa0d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit 3d98df472498e1273369d23822d10db14f337443
bgruening
parents: 15
diff changeset
55 <param argument="--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"/>
8e649f27aa0d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit 3d98df472498e1273369d23822d10db14f337443
bgruening
parents: 15
diff changeset
56 <param argument="--mapout" type="boolean" truevalue="--mapout" falsevalue="" checked="False" label="Output a correspondance table of position." 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"/>
8e649f27aa0d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit 3d98df472498e1273369d23822d10db14f337443
bgruening
parents: 15
diff changeset
57 <param argument="--reorder" type="boolean" truevalue="" falsevalue="--reorder" checked="True" label="Preserve the original order of sequences."/>
8e649f27aa0d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit 3d98df472498e1273369d23822d10db14f337443
bgruening
parents: 15
diff changeset
58 </inputs>
8e649f27aa0d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit 3d98df472498e1273369d23822d10db14f337443
bgruening
parents: 15
diff changeset
59 <outputs>
8e649f27aa0d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit 3d98df472498e1273369d23822d10db14f337443
bgruening
parents: 15
diff changeset
60 <data format="fasta" name="outputAlignment" label="${tool.name} on ${on_string} : New alignment"/>
8e649f27aa0d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit 3d98df472498e1273369d23822d10db14f337443
bgruening
parents: 15
diff changeset
61 <data name="outputmap" format="tabular" label="${tool.name} on ${on_string} : Correspondance of positions ">
8e649f27aa0d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit 3d98df472498e1273369d23822d10db14f337443
bgruening
parents: 15
diff changeset
62 <filter>map == True</filter>
8e649f27aa0d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit 3d98df472498e1273369d23822d10db14f337443
bgruening
parents: 15
diff changeset
63 </data>
8e649f27aa0d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit 3d98df472498e1273369d23822d10db14f337443
bgruening
parents: 15
diff changeset
64 </outputs>
8e649f27aa0d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit 3d98df472498e1273369d23822d10db14f337443
bgruening
parents: 15
diff changeset
65 <tests>
8e649f27aa0d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit 3d98df472498e1273369d23822d10db14f337443
bgruening
parents: 15
diff changeset
66 <test expect_num_outputs="1">
8e649f27aa0d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit 3d98df472498e1273369d23822d10db14f337443
bgruening
parents: 15
diff changeset
67 <param name="inputSequences" value="add_seq.fa"/>
8e649f27aa0d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit 3d98df472498e1273369d23822d10db14f337443
bgruening
parents: 15
diff changeset
68 <param name="inputAlignment" value="mafft_default.aln"/>
8e649f27aa0d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit 3d98df472498e1273369d23822d10db14f337443
bgruening
parents: 15
diff changeset
69 <param name="sequenceType" value="singleseq"/>
8e649f27aa0d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit 3d98df472498e1273369d23822d10db14f337443
bgruening
parents: 15
diff changeset
70 <param name="preservegap" value="--add"/>
8e649f27aa0d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit 3d98df472498e1273369d23822d10db14f337443
bgruening
parents: 15
diff changeset
71 <param name="keeplength" value="--keeplength"/>
8e649f27aa0d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit 3d98df472498e1273369d23822d10db14f337443
bgruening
parents: 15
diff changeset
72 <param name="mapout" value=""/>
8e649f27aa0d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit 3d98df472498e1273369d23822d10db14f337443
bgruening
parents: 15
diff changeset
73 <output name="outputAlignment" ftype="fasta" file="mafft_add_result.aln"/>
8e649f27aa0d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit 3d98df472498e1273369d23822d10db14f337443
bgruening
parents: 15
diff changeset
74 </test>
8e649f27aa0d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit 3d98df472498e1273369d23822d10db14f337443
bgruening
parents: 15
diff changeset
75 </tests>
8e649f27aa0d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit 3d98df472498e1273369d23822d10db14f337443
bgruening
parents: 15
diff changeset
76 <help>
7
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
77 <![CDATA[
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
78 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
79
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
80 - 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
81 - 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
82 - 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
83 - 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
84 - 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
85 - --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
86 - 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
87
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
88 ]]>
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
89 </help>
16
8e649f27aa0d planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit 3d98df472498e1273369d23822d10db14f337443
bgruening
parents: 15
diff changeset
90 <expand macro="citations"/>
7
aaefa93c2dd2 "planemo upload for repository https://github.com/bgruening/galaxytools/tree/master/tools/mafft commit eff9db2cd18c82a7de37851571b8989b48014c71"
rnateam
parents:
diff changeset
91 </tool>