Mercurial > repos > iuc > seqtk

annotate seqtk_sample.xml @ 22:f2a792351212 draft default tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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:17 +0000
parents 8f26884c60b6
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
33ded39275c3 Uploaded
iuc
parents:
diff changeset
1 <?xml version="1.0"?>
22
f2a792351212 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 75d5141110314addc160504e0a1f9cd66443de66
iuc
parents: 20
diff changeset
2 <tool id="seqtk_sample" name="seqtk_sample" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="22.05">
0
33ded39275c3 Uploaded
iuc
parents:
diff changeset
3 <description>random subsample of fasta or fastq sequences</description>
15
16f2535c08bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 7379d9f8823d3c639c8119b116e141d0a736ca1d
iuc
parents: 7
diff changeset
4 <macros>
16f2535c08bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 7379d9f8823d3c639c8119b116e141d0a736ca1d
iuc
parents: 7
diff changeset
5 <import>macros.xml</import>
16f2535c08bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 7379d9f8823d3c639c8119b116e141d0a736ca1d
iuc
parents: 7
diff changeset
6 </macros>
22
f2a792351212 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 75d5141110314addc160504e0a1f9cd66443de66
iuc
parents: 20
diff changeset
7 <expand macro="bio_tools"/>
15
16f2535c08bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 7379d9f8823d3c639c8119b116e141d0a736ca1d
iuc
parents: 7
diff changeset
8 <expand macro="requirements"/>
16f2535c08bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 7379d9f8823d3c639c8119b116e141d0a736ca1d
iuc
parents: 7
diff changeset
9 <expand macro="stdio"/>
16f2535c08bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 7379d9f8823d3c639c8119b116e141d0a736ca1d
iuc
parents: 7
diff changeset
10 <command><![CDATA[
16f2535c08bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 7379d9f8823d3c639c8119b116e141d0a736ca1d
iuc
parents: 7
diff changeset
11 seqtk sample
16f2535c08bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 7379d9f8823d3c639c8119b116e141d0a736ca1d
iuc
parents: 7
diff changeset
12 -s $s
18
1d63dbcecb10 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 50a0bd6d783a69e7303363a31130134767493e66"
iuc
parents: 17
diff changeset
13 $advanced.single_pass_mode
15
16f2535c08bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 7379d9f8823d3c639c8119b116e141d0a736ca1d
iuc
parents: 7
diff changeset
14 '$in_file'
16f2535c08bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 7379d9f8823d3c639c8119b116e141d0a736ca1d
iuc
parents: 7
diff changeset
15 $subsample_size
16
48a51c72f5e7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit ad43df79dca3dc7c3511c6eb2ccf8589d2804eb2
iuc
parents: 15
diff changeset
16 @CONDITIONAL_GZIP_OUT@
15
16f2535c08bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 7379d9f8823d3c639c8119b116e141d0a736ca1d
iuc
parents: 7
diff changeset
17 ]]></command>
16f2535c08bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 7379d9f8823d3c639c8119b116e141d0a736ca1d
iuc
parents: 7
diff changeset
18 <inputs>
16f2535c08bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 7379d9f8823d3c639c8119b116e141d0a736ca1d
iuc
parents: 7
diff changeset
19 <expand macro="in_faq" />
18
1d63dbcecb10 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 50a0bd6d783a69e7303363a31130134767493e66"
iuc
parents: 17
diff changeset
20 <param argument="-s" type="integer" value="4" label="RNG seed" help="The seed used for the random number generator. Manually specifying a number here is useful for reproducing the same subsampling in different runs (e.g. read 1 and read 2)" />
1d63dbcecb10 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 50a0bd6d783a69e7303363a31130134767493e66"
iuc
parents: 17
diff changeset
21 <param name="subsample_size" type="float" value="100" label="Subsample (decimal fraction or number)" help="Use an integer > 1 to select a specific number of reads. Use a decimal (e.g. 0.5) to select a fraction of reads"/>
1d63dbcecb10 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 50a0bd6d783a69e7303363a31130134767493e66"
iuc
parents: 17
diff changeset
22 <section name="advanced" title="Advanced options" expanded="false">
1d63dbcecb10 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 50a0bd6d783a69e7303363a31130134767493e66"
iuc
parents: 17
diff changeset
23 <param name="single_pass_mode" type="boolean" truevalue="" falsevalue="-2" checked="false" label="Enable 1-pass mode" help="Use this if the number of reads you want to sample is small enough to fit into memory. If you're not sure, don't use this."/>
1d63dbcecb10 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 50a0bd6d783a69e7303363a31130134767493e66"
iuc
parents: 17
diff changeset
24 </section>
15
16f2535c08bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 7379d9f8823d3c639c8119b116e141d0a736ca1d
iuc
parents: 7
diff changeset
25 </inputs>
16f2535c08bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 7379d9f8823d3c639c8119b116e141d0a736ca1d
iuc
parents: 7
diff changeset
26 <outputs>
22
f2a792351212 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 75d5141110314addc160504e0a1f9cd66443de66
iuc
parents: 20
diff changeset
27 <data name="default" format_source="in_file" label="${tool.name} on ${on_string}: Subsample of reads"/>
15
16f2535c08bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 7379d9f8823d3c639c8119b116e141d0a736ca1d
iuc
parents: 7
diff changeset
28 </outputs>
16f2535c08bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 7379d9f8823d3c639c8119b116e141d0a736ca1d
iuc
parents: 7
diff changeset
29 <tests>
16f2535c08bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 7379d9f8823d3c639c8119b116e141d0a736ca1d
iuc
parents: 7
diff changeset
30 <test>
16f2535c08bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 7379d9f8823d3c639c8119b116e141d0a736ca1d
iuc
parents: 7
diff changeset
31 <param name="in_file" value="seqtk_sample.fa"/>
16f2535c08bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 7379d9f8823d3c639c8119b116e141d0a736ca1d
iuc
parents: 7
diff changeset
32 <param name="subsample_size" value="4"/>
16f2535c08bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 7379d9f8823d3c639c8119b116e141d0a736ca1d
iuc
parents: 7
diff changeset
33 <param name="s" value="4"/>
18
1d63dbcecb10 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 50a0bd6d783a69e7303363a31130134767493e66"
iuc
parents: 17
diff changeset
34 <param name="advanced|single_pass_mode" value="True"/>
15
16f2535c08bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 7379d9f8823d3c639c8119b116e141d0a736ca1d
iuc
parents: 7
diff changeset
35 <output name="default" file="seqtk_sample.out" ftype="fasta"/>
16f2535c08bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 7379d9f8823d3c639c8119b116e141d0a736ca1d
iuc
parents: 7
diff changeset
36 </test>
16
48a51c72f5e7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit ad43df79dca3dc7c3511c6eb2ccf8589d2804eb2
iuc
parents: 15
diff changeset
37 <test>
48a51c72f5e7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit ad43df79dca3dc7c3511c6eb2ccf8589d2804eb2
iuc
parents: 15
diff changeset
38 <param name="in_file" value="seqtk_sample.fa.gz" ftype="fasta.gz"/>
48a51c72f5e7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit ad43df79dca3dc7c3511c6eb2ccf8589d2804eb2
iuc
parents: 15
diff changeset
39 <param name="subsample_size" value="4"/>
48a51c72f5e7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit ad43df79dca3dc7c3511c6eb2ccf8589d2804eb2
iuc
parents: 15
diff changeset
40 <param name="s" value="4"/>
18
1d63dbcecb10 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 50a0bd6d783a69e7303363a31130134767493e66"
iuc
parents: 17
diff changeset
41 <param name="advanced|single_pass_mode" value='True'/>
16
48a51c72f5e7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit ad43df79dca3dc7c3511c6eb2ccf8589d2804eb2
iuc
parents: 15
diff changeset
42 <output name="default" file="seqtk_sample.out.gz" ftype="fasta.gz"/>
48a51c72f5e7 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit ad43df79dca3dc7c3511c6eb2ccf8589d2804eb2
iuc
parents: 15
diff changeset
43 </test>
18
1d63dbcecb10 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 50a0bd6d783a69e7303363a31130134767493e66"
iuc
parents: 17
diff changeset
44 <test>
1d63dbcecb10 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 50a0bd6d783a69e7303363a31130134767493e66"
iuc
parents: 17
diff changeset
45 <param name="in_file" value="seqtk_sample.fa.gz" ftype="fasta.gz"/>
1d63dbcecb10 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 50a0bd6d783a69e7303363a31130134767493e66"
iuc
parents: 17
diff changeset
46 <param name="subsample_size" value="4"/>
1d63dbcecb10 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 50a0bd6d783a69e7303363a31130134767493e66"
iuc
parents: 17
diff changeset
47 <param name="s" value="4"/>
1d63dbcecb10 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 50a0bd6d783a69e7303363a31130134767493e66"
iuc
parents: 17
diff changeset
48 <param name="advanced|single_pass_mode" value='False'/>
1d63dbcecb10 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 50a0bd6d783a69e7303363a31130134767493e66"
iuc
parents: 17
diff changeset
49 <output name="default" file="seqtk_sample.lowmem.gz" ftype="fasta.gz"/>
1d63dbcecb10 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 50a0bd6d783a69e7303363a31130134767493e66"
iuc
parents: 17
diff changeset
50 </test>
15
16f2535c08bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 7379d9f8823d3c639c8119b116e141d0a736ca1d
iuc
parents: 7
diff changeset
51 </tests>
16f2535c08bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 7379d9f8823d3c639c8119b116e141d0a736ca1d
iuc
parents: 7
diff changeset
52 <help><![CDATA[
0
33ded39275c3 Uploaded
iuc
parents:
diff changeset
53 **What it does**
33ded39275c3 Uploaded
iuc
parents:
diff changeset
54
15
16f2535c08bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 7379d9f8823d3c639c8119b116e141d0a736ca1d
iuc
parents: 7
diff changeset
55 Takes a random subsample of FASTA or FASTQ sequences. The RNG is seedable to allow for reproducible results, and defaults to `4 <http://xkcd.com/221/>`__.
0
33ded39275c3 Uploaded
iuc
parents:
diff changeset
56
33ded39275c3 Uploaded
iuc
parents:
diff changeset
57 The subsample size can be a decimal fraction <=1, where 1 implies 100% of the reads should be used. If a number >1 is provided, that many reads will be taken from the dataset.
33ded39275c3 Uploaded
iuc
parents:
diff changeset
58
18
1d63dbcecb10 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 50a0bd6d783a69e7303363a31130134767493e66"
iuc
parents: 17
diff changeset
59 Two pass sampling mode reads the input file once to build a list of reads to output then again to output the reads. It is twice as slow, but uses much less RAM. It is only in effect when an integer number of reads (not a fraction) is specified as subsample size.
1d63dbcecb10 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 50a0bd6d783a69e7303363a31130134767493e66"
iuc
parents: 17
diff changeset
60
0
33ded39275c3 Uploaded
iuc
parents:
diff changeset
61 @ATTRIBUTION@
15
16f2535c08bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 7379d9f8823d3c639c8119b116e141d0a736ca1d
iuc
parents: 7
diff changeset
62 ]]></help>
16f2535c08bf planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/seqtk commit 7379d9f8823d3c639c8119b116e141d0a736ca1d
iuc
parents: 7
diff changeset
63 <expand macro="citation" />
0
33ded39275c3 Uploaded
iuc
parents:
diff changeset
64 </tool>