annotate seqtk_mergefa.xml @ 10:a019807f4e67 draft default tip

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 75d5141110314addc160504e0a1f9cd66443de66
author iuc
date Wed, 16 Oct 2024 09:08:52 +0000
parents 4b494533146a
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
e0a0fd938de4 Uploaded
iuc
parents:
diff changeset
1 <?xml version="1.0"?>
10
a019807f4e67 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 75d5141110314addc160504e0a1f9cd66443de66
iuc
parents: 9
diff changeset
2 <tool id="seqtk_mergefa" name="seqtk_mergefa" version="@TOOL_VERSION@+galaxy1" profile="22.05">
a019807f4e67 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 75d5141110314addc160504e0a1f9cd66443de66
iuc
parents: 9
diff changeset
3 <description>Merge two FASTA/Q files into a FASTA file output</description>
3
bc7d99f46a5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 7379d9f8823d3c639c8119b116e141d0a736ca1d
iuc
parents: 2
diff changeset
4 <macros>
bc7d99f46a5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 7379d9f8823d3c639c8119b116e141d0a736ca1d
iuc
parents: 2
diff changeset
5 <import>macros.xml</import>
bc7d99f46a5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 7379d9f8823d3c639c8119b116e141d0a736ca1d
iuc
parents: 2
diff changeset
6 </macros>
9
4b494533146a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 2f75805e2e6cfa2af15076e6f4929b87631360a6
iuc
parents: 8
diff changeset
7 <expand macro="bio_tools"/>
3
bc7d99f46a5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 7379d9f8823d3c639c8119b116e141d0a736ca1d
iuc
parents: 2
diff changeset
8 <expand macro="requirements"/>
bc7d99f46a5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 7379d9f8823d3c639c8119b116e141d0a736ca1d
iuc
parents: 2
diff changeset
9 <expand macro="stdio"/>
bc7d99f46a5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 7379d9f8823d3c639c8119b116e141d0a736ca1d
iuc
parents: 2
diff changeset
10 <command><![CDATA[
bc7d99f46a5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 7379d9f8823d3c639c8119b116e141d0a736ca1d
iuc
parents: 2
diff changeset
11 seqtk mergefa
bc7d99f46a5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 7379d9f8823d3c639c8119b116e141d0a736ca1d
iuc
parents: 2
diff changeset
12 -q $q
0
e0a0fd938de4 Uploaded
iuc
parents:
diff changeset
13 $i
e0a0fd938de4 Uploaded
iuc
parents:
diff changeset
14 $m
e0a0fd938de4 Uploaded
iuc
parents:
diff changeset
15 $r
e0a0fd938de4 Uploaded
iuc
parents:
diff changeset
16 $h
3
bc7d99f46a5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 7379d9f8823d3c639c8119b116e141d0a736ca1d
iuc
parents: 2
diff changeset
17 '$in_fa1'
bc7d99f46a5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 7379d9f8823d3c639c8119b116e141d0a736ca1d
iuc
parents: 2
diff changeset
18 '$in_fa2'
7
58c8ece95b53 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 35c8480f525d211d5e9996086c60b2c6d4f89146"
iuc
parents: 5
diff changeset
19 #echo "| pigz -p ${GALAXY_SLOTS:-1} --no-name --no-time" if $in_fa1.is_of_type('fasta.gz', 'fastq.gz') else "" # > '$default'
3
bc7d99f46a5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 7379d9f8823d3c639c8119b116e141d0a736ca1d
iuc
parents: 2
diff changeset
20 ]]></command>
10
a019807f4e67 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 75d5141110314addc160504e0a1f9cd66443de66
iuc
parents: 9
diff changeset
21 <configfiles>
a019807f4e67 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 75d5141110314addc160504e0a1f9cd66443de66
iuc
parents: 9
diff changeset
22 <configfile filename="outputs.json">
a019807f4e67 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 75d5141110314addc160504e0a1f9cd66443de66
iuc
parents: 9
diff changeset
23 #set $ext = None
a019807f4e67 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 75d5141110314addc160504e0a1f9cd66443de66
iuc
parents: 9
diff changeset
24 #if $in_fa1.is_of_type('fasta.gz', 'fastq.gz')
a019807f4e67 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 75d5141110314addc160504e0a1f9cd66443de66
iuc
parents: 9
diff changeset
25 #set $ext = "fasta.gz"
a019807f4e67 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 75d5141110314addc160504e0a1f9cd66443de66
iuc
parents: 9
diff changeset
26 #else
a019807f4e67 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 75d5141110314addc160504e0a1f9cd66443de66
iuc
parents: 9
diff changeset
27 #set $ext = "fasta"
a019807f4e67 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 75d5141110314addc160504e0a1f9cd66443de66
iuc
parents: 9
diff changeset
28 #end if
a019807f4e67 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 75d5141110314addc160504e0a1f9cd66443de66
iuc
parents: 9
diff changeset
29 {"default": {"ext": "$ext"}}
a019807f4e67 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 75d5141110314addc160504e0a1f9cd66443de66
iuc
parents: 9
diff changeset
30 </configfile>
a019807f4e67 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 75d5141110314addc160504e0a1f9cd66443de66
iuc
parents: 9
diff changeset
31 </configfiles>
3
bc7d99f46a5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 7379d9f8823d3c639c8119b116e141d0a736ca1d
iuc
parents: 2
diff changeset
32 <inputs>
4
ecf1c30da3a2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit ad43df79dca3dc7c3511c6eb2ccf8589d2804eb2
iuc
parents: 3
diff changeset
33 <param name="in_fa1" type="data" format="fasta,fastq,fasta.gz,fastq.gz" label="Input FASTA/Q file #1"/>
ecf1c30da3a2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit ad43df79dca3dc7c3511c6eb2ccf8589d2804eb2
iuc
parents: 3
diff changeset
34 <param name="in_fa2" type="data" format="fasta,fastq,fasta.gz,fastq.gz" label="Input FASTA/Q file #2"/>
10
a019807f4e67 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 75d5141110314addc160504e0a1f9cd66443de66
iuc
parents: 9
diff changeset
35 <param argument="-q" type="integer" value="0" label="Quality threshold (for FASTQ)"/>
3
bc7d99f46a5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 7379d9f8823d3c639c8119b116e141d0a736ca1d
iuc
parents: 2
diff changeset
36 <param argument="-i" type="boolean" truevalue="-i" falsevalue="" checked="false" label="Take intersection" />
10
a019807f4e67 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 75d5141110314addc160504e0a1f9cd66443de66
iuc
parents: 9
diff changeset
37 <param argument="-m" type="boolean" truevalue="-m" falsevalue="" checked="false" label="Pick least ambiguous, mask conflicts and uncertainties" help="Tries to pick the least ambiguous symbol from the two inputs, but masks contradictory bases in the inputs as x in the merged result and converts the merged base to lowercase where one of the input bases is an N." />
3
bc7d99f46a5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 7379d9f8823d3c639c8119b116e141d0a736ca1d
iuc
parents: 2
diff changeset
38 <param argument="-r" type="boolean" truevalue="-r" falsevalue="" checked="false" label="Pick a random allele from het" />
bc7d99f46a5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 7379d9f8823d3c639c8119b116e141d0a736ca1d
iuc
parents: 2
diff changeset
39 <param argument="-h" type="boolean" truevalue="-h" falsevalue="" checked="false" label="Suppress hets in the input" />
bc7d99f46a5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 7379d9f8823d3c639c8119b116e141d0a736ca1d
iuc
parents: 2
diff changeset
40 </inputs>
10
a019807f4e67 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 75d5141110314addc160504e0a1f9cd66443de66
iuc
parents: 9
diff changeset
41 <outputs provided_metadata_file="outputs.json">
a019807f4e67 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 75d5141110314addc160504e0a1f9cd66443de66
iuc
parents: 9
diff changeset
42 <data name="default" format="auto" label="${tool.name} on ${on_string}" />
3
bc7d99f46a5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 7379d9f8823d3c639c8119b116e141d0a736ca1d
iuc
parents: 2
diff changeset
43 </outputs>
bc7d99f46a5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 7379d9f8823d3c639c8119b116e141d0a736ca1d
iuc
parents: 2
diff changeset
44 <tests>
bc7d99f46a5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 7379d9f8823d3c639c8119b116e141d0a736ca1d
iuc
parents: 2
diff changeset
45 <test>
bc7d99f46a5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 7379d9f8823d3c639c8119b116e141d0a736ca1d
iuc
parents: 2
diff changeset
46 <param name="in_fa1" value="seqtk_mergefa1.fa"/>
bc7d99f46a5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 7379d9f8823d3c639c8119b116e141d0a736ca1d
iuc
parents: 2
diff changeset
47 <param name="in_fa2" value="seqtk_mergefa2.fa"/>
bc7d99f46a5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 7379d9f8823d3c639c8119b116e141d0a736ca1d
iuc
parents: 2
diff changeset
48 <output name="default" file="seqtk_mergefa.out" ftype="fasta"/>
bc7d99f46a5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 7379d9f8823d3c639c8119b116e141d0a736ca1d
iuc
parents: 2
diff changeset
49 </test>
bc7d99f46a5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 7379d9f8823d3c639c8119b116e141d0a736ca1d
iuc
parents: 2
diff changeset
50 <test>
bc7d99f46a5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 7379d9f8823d3c639c8119b116e141d0a736ca1d
iuc
parents: 2
diff changeset
51 <param name="in_fa1" value="seqtk_mergefa1.fa"/>
bc7d99f46a5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 7379d9f8823d3c639c8119b116e141d0a736ca1d
iuc
parents: 2
diff changeset
52 <param name="in_fa2" value="seqtk_mergefa2.fa"/>
bc7d99f46a5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 7379d9f8823d3c639c8119b116e141d0a736ca1d
iuc
parents: 2
diff changeset
53 <param name="m" value="True" />
bc7d99f46a5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 7379d9f8823d3c639c8119b116e141d0a736ca1d
iuc
parents: 2
diff changeset
54 <output name="default" file="seqtk_mergefa2.out" ftype="fasta"/>
bc7d99f46a5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 7379d9f8823d3c639c8119b116e141d0a736ca1d
iuc
parents: 2
diff changeset
55 </test>
4
ecf1c30da3a2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit ad43df79dca3dc7c3511c6eb2ccf8589d2804eb2
iuc
parents: 3
diff changeset
56 <test>
ecf1c30da3a2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit ad43df79dca3dc7c3511c6eb2ccf8589d2804eb2
iuc
parents: 3
diff changeset
57 <param name="in_fa1" value="seqtk_mergefa1.fa.gz" ftype="fasta.gz"/>
ecf1c30da3a2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit ad43df79dca3dc7c3511c6eb2ccf8589d2804eb2
iuc
parents: 3
diff changeset
58 <param name="in_fa2" value="seqtk_mergefa2.fa.gz" ftype="fasta.gz"/>
ecf1c30da3a2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit ad43df79dca3dc7c3511c6eb2ccf8589d2804eb2
iuc
parents: 3
diff changeset
59 <param name="m" value="True" />
ecf1c30da3a2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit ad43df79dca3dc7c3511c6eb2ccf8589d2804eb2
iuc
parents: 3
diff changeset
60 <output name="default" file="seqtk_mergefa2.out.gz" ftype="fasta.gz"/>
ecf1c30da3a2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit ad43df79dca3dc7c3511c6eb2ccf8589d2804eb2
iuc
parents: 3
diff changeset
61 </test>
3
bc7d99f46a5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 7379d9f8823d3c639c8119b116e141d0a736ca1d
iuc
parents: 2
diff changeset
62 </tests>
bc7d99f46a5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 7379d9f8823d3c639c8119b116e141d0a736ca1d
iuc
parents: 2
diff changeset
63 <help><![CDATA[
0
e0a0fd938de4 Uploaded
iuc
parents:
diff changeset
64 **What it does**
e0a0fd938de4 Uploaded
iuc
parents:
diff changeset
65
10
a019807f4e67 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 75d5141110314addc160504e0a1f9cd66443de66
iuc
parents: 9
diff changeset
66 This tool merges two FASTA or FASTQ files into a single FASTA file using IUPAC ambiguity codes where appropriate.
a019807f4e67 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 75d5141110314addc160504e0a1f9cd66443de66
iuc
parents: 9
diff changeset
67 When differences occur between the sequences, ambiguity codes are used to represent possible variations.
0
e0a0fd938de4 Uploaded
iuc
parents:
diff changeset
68
10
a019807f4e67 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 75d5141110314addc160504e0a1f9cd66443de66
iuc
parents: 9
diff changeset
69 Example::
0
e0a0fd938de4 Uploaded
iuc
parents:
diff changeset
70
10
a019807f4e67 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 75d5141110314addc160504e0a1f9cd66443de66
iuc
parents: 9
diff changeset
71 >seq1
a019807f4e67 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 75d5141110314addc160504e0a1f9cd66443de66
iuc
parents: 9
diff changeset
72 ACTGACTGAAA
a019807f4e67 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 75d5141110314addc160504e0a1f9cd66443de66
iuc
parents: 9
diff changeset
73
a019807f4e67 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 75d5141110314addc160504e0a1f9cd66443de66
iuc
parents: 9
diff changeset
74 >seq2
a019807f4e67 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 75d5141110314addc160504e0a1f9cd66443de66
iuc
parents: 9
diff changeset
75 ACTGAMTGCGN
0
e0a0fd938de4 Uploaded
iuc
parents:
diff changeset
76
10
a019807f4e67 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 75d5141110314addc160504e0a1f9cd66443de66
iuc
parents: 9
diff changeset
77 will result in::
a019807f4e67 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 75d5141110314addc160504e0a1f9cd66443de66
iuc
parents: 9
diff changeset
78
a019807f4e67 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 75d5141110314addc160504e0a1f9cd66443de66
iuc
parents: 9
diff changeset
79 >seq1
a019807f4e67 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 75d5141110314addc160504e0a1f9cd66443de66
iuc
parents: 9
diff changeset
80 ACTGAMTGMRN
0
e0a0fd938de4 Uploaded
iuc
parents:
diff changeset
81
10
a019807f4e67 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 75d5141110314addc160504e0a1f9cd66443de66
iuc
parents: 9
diff changeset
82 If the `-m` option is in use, however, the tool will pick the least ambiguous base if there is no contradiction between the symbols in the inputs. Conflicts are indicated by using x in the merged sequence and the picked base is converted to lowercase if the less specific symbol is an N to express uncertainty.
a019807f4e67 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 75d5141110314addc160504e0a1f9cd66443de66
iuc
parents: 9
diff changeset
83 With this logic the input sequences above will result in the merge result::
0
e0a0fd938de4 Uploaded
iuc
parents:
diff changeset
84
10
a019807f4e67 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 75d5141110314addc160504e0a1f9cd66443de66
iuc
parents: 9
diff changeset
85 >seq1
a019807f4e67 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 75d5141110314addc160504e0a1f9cd66443de66
iuc
parents: 9
diff changeset
86 ACTGACTGxxa
0
e0a0fd938de4 Uploaded
iuc
parents:
diff changeset
87
e0a0fd938de4 Uploaded
iuc
parents:
diff changeset
88 @ATTRIBUTION@
3
bc7d99f46a5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 7379d9f8823d3c639c8119b116e141d0a736ca1d
iuc
parents: 2
diff changeset
89 ]]></help>
bc7d99f46a5d planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 7379d9f8823d3c639c8119b116e141d0a736ca1d
iuc
parents: 2
diff changeset
90 <expand macro="citation" />
0
e0a0fd938de4 Uploaded
iuc
parents:
diff changeset
91 </tool>