annotate fermi2.xml @ 0:b808c0bc19a9 draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fermikit commit 47795b03c956d0f239aede8e27d2aa4e3c4c1d27
author mvdbeek
date Fri, 30 Dec 2016 10:25:59 -0500
parents
children adf010a51dde
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
b808c0bc19a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fermikit commit 47795b03c956d0f239aede8e27d2aa4e3c4c1d27
mvdbeek
parents:
diff changeset
1 <tool id="fermi2" name="fermi2" version="0.14.dev1">
b808c0bc19a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fermikit commit 47795b03c956d0f239aede8e27d2aa4e3c4c1d27
mvdbeek
parents:
diff changeset
2 <description>assembles Illumina reads into unitigs</description>
b808c0bc19a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fermikit commit 47795b03c956d0f239aede8e27d2aa4e3c4c1d27
mvdbeek
parents:
diff changeset
3 <requirements>
b808c0bc19a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fermikit commit 47795b03c956d0f239aede8e27d2aa4e3c4c1d27
mvdbeek
parents:
diff changeset
4 <requirement type="package" version="r188">fermi2</requirement>
b808c0bc19a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fermikit commit 47795b03c956d0f239aede8e27d2aa4e3c4c1d27
mvdbeek
parents:
diff changeset
5 <requirement type="package" version="r181">bfc</requirement>
b808c0bc19a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fermikit commit 47795b03c956d0f239aede8e27d2aa4e3c4c1d27
mvdbeek
parents:
diff changeset
6 </requirements>
b808c0bc19a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fermikit commit 47795b03c956d0f239aede8e27d2aa4e3c4c1d27
mvdbeek
parents:
diff changeset
7 <command detect_errors="aggressive"><![CDATA[
b808c0bc19a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fermikit commit 47795b03c956d0f239aede8e27d2aa4e3c4c1d27
mvdbeek
parents:
diff changeset
8 fermi2.pl unitig
b808c0bc19a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fermikit commit 47795b03c956d0f239aede8e27d2aa4e3c4c1d27
mvdbeek
parents:
diff changeset
9 -s$genome_size
b808c0bc19a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fermikit commit 47795b03c956d0f239aede8e27d2aa4e3c4c1d27
mvdbeek
parents:
diff changeset
10 -t\${GALAXY_SLOTS:-4}
b808c0bc19a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fermikit commit 47795b03c956d0f239aede8e27d2aa4e3c4c1d27
mvdbeek
parents:
diff changeset
11 -l$readlength
b808c0bc19a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fermikit commit 47795b03c956d0f239aede8e27d2aa4e3c4c1d27
mvdbeek
parents:
diff changeset
12 -p prefix '$input1'
b808c0bc19a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fermikit commit 47795b03c956d0f239aede8e27d2aa4e3c4c1d27
mvdbeek
parents:
diff changeset
13 $T
b808c0bc19a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fermikit commit 47795b03c956d0f239aede8e27d2aa4e3c4c1d27
mvdbeek
parents:
diff changeset
14 $2
b808c0bc19a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fermikit commit 47795b03c956d0f239aede8e27d2aa4e3c4c1d27
mvdbeek
parents:
diff changeset
15 $E
b808c0bc19a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fermikit commit 47795b03c956d0f239aede8e27d2aa4e3c4c1d27
mvdbeek
parents:
diff changeset
16 > prefix.mak &&
b808c0bc19a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fermikit commit 47795b03c956d0f239aede8e27d2aa4e3c4c1d27
mvdbeek
parents:
diff changeset
17 make -f prefix.mak
b808c0bc19a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fermikit commit 47795b03c956d0f239aede8e27d2aa4e3c4c1d27
mvdbeek
parents:
diff changeset
18 ]]></command>
b808c0bc19a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fermikit commit 47795b03c956d0f239aede8e27d2aa4e3c4c1d27
mvdbeek
parents:
diff changeset
19 <inputs>
b808c0bc19a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fermikit commit 47795b03c956d0f239aede8e27d2aa4e3c4c1d27
mvdbeek
parents:
diff changeset
20 <param type="data" name="input1" format="fastqsanger,fastqsanger.gz"/>
b808c0bc19a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fermikit commit 47795b03c956d0f239aede8e27d2aa4e3c4c1d27
mvdbeek
parents:
diff changeset
21 <param argument="-l" name="readlength" type="integer" label="primary read length" value="101" min="70"/>
b808c0bc19a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fermikit commit 47795b03c956d0f239aede8e27d2aa4e3c4c1d27
mvdbeek
parents:
diff changeset
22 <param argument="-s" name="genome_size" type="integer" value="180000" min="1" label="approximate genome size in kilobases" help="Enter approximate genome size in kilobases. For a human genome of 3.2 gigabases enter 3200000"/>
b808c0bc19a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fermikit commit 47795b03c956d0f239aede8e27d2aa4e3c4c1d27
mvdbeek
parents:
diff changeset
23 <param argument="-T" type="integer" value="61" label="use INT-mer for post-trimming/filtering" min="10"/>
b808c0bc19a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fermikit commit 47795b03c956d0f239aede8e27d2aa4e3c4c1d27
mvdbeek
parents:
diff changeset
24 <param argument="-2" type="boolean" checked="false" truevalue="-2" falsevalue="" label="Use 2-pass error correction"/>
b808c0bc19a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fermikit commit 47795b03c956d0f239aede8e27d2aa4e3c4c1d27
mvdbeek
parents:
diff changeset
25 <param argument="-E" type="boolean" checked="false" truevalue="-E" falsevalue="" label="Do not apply error correction"/>
b808c0bc19a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fermikit commit 47795b03c956d0f239aede8e27d2aa4e3c4c1d27
mvdbeek
parents:
diff changeset
26 </inputs>
b808c0bc19a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fermikit commit 47795b03c956d0f239aede8e27d2aa4e3c4c1d27
mvdbeek
parents:
diff changeset
27 <outputs>
b808c0bc19a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fermikit commit 47795b03c956d0f239aede8e27d2aa4e3c4c1d27
mvdbeek
parents:
diff changeset
28 <data name="unitigs" format="fastqsanger.gz" from_work_dir="prefix.mag.gz"/>
b808c0bc19a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fermikit commit 47795b03c956d0f239aede8e27d2aa4e3c4c1d27
mvdbeek
parents:
diff changeset
29 </outputs>
b808c0bc19a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fermikit commit 47795b03c956d0f239aede8e27d2aa4e3c4c1d27
mvdbeek
parents:
diff changeset
30 <tests>
b808c0bc19a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fermikit commit 47795b03c956d0f239aede8e27d2aa4e3c4c1d27
mvdbeek
parents:
diff changeset
31 <test>
b808c0bc19a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fermikit commit 47795b03c956d0f239aede8e27d2aa4e3c4c1d27
mvdbeek
parents:
diff changeset
32 <param name="input1" value="test.fastq.gz"/>
b808c0bc19a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fermikit commit 47795b03c956d0f239aede8e27d2aa4e3c4c1d27
mvdbeek
parents:
diff changeset
33 <param name="readlength" value="150"/>
b808c0bc19a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fermikit commit 47795b03c956d0f239aede8e27d2aa4e3c4c1d27
mvdbeek
parents:
diff changeset
34 <param name="genome_size" value="1"/>
b808c0bc19a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fermikit commit 47795b03c956d0f239aede8e27d2aa4e3c4c1d27
mvdbeek
parents:
diff changeset
35 <output name="unitigs" file="unitigs.gz" compare="sim_size"/>
b808c0bc19a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fermikit commit 47795b03c956d0f239aede8e27d2aa4e3c4c1d27
mvdbeek
parents:
diff changeset
36 </test>
b808c0bc19a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fermikit commit 47795b03c956d0f239aede8e27d2aa4e3c4c1d27
mvdbeek
parents:
diff changeset
37 </tests>
b808c0bc19a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fermikit commit 47795b03c956d0f239aede8e27d2aa4e3c4c1d27
mvdbeek
parents:
diff changeset
38 <help><![CDATA[
b808c0bc19a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fermikit commit 47795b03c956d0f239aede8e27d2aa4e3c4c1d27
mvdbeek
parents:
diff changeset
39 fermi2 can assemble reads into unitigs.
b808c0bc19a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fermikit commit 47795b03c956d0f239aede8e27d2aa4e3c4c1d27
mvdbeek
parents:
diff changeset
40 Unitig output can be further analysed by alignment to a reference genome using bwa-mem,
b808c0bc19a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fermikit commit 47795b03c956d0f239aede8e27d2aa4e3c4c1d27
mvdbeek
parents:
diff changeset
41 and based on the alignment variants can be called using the fermi-variants tool.
b808c0bc19a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fermikit commit 47795b03c956d0f239aede8e27d2aa4e3c4c1d27
mvdbeek
parents:
diff changeset
42
b808c0bc19a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fermikit commit 47795b03c956d0f239aede8e27d2aa4e3c4c1d27
mvdbeek
parents:
diff changeset
43 ::
b808c0bc19a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fermikit commit 47795b03c956d0f239aede8e27d2aa4e3c4c1d27
mvdbeek
parents:
diff changeset
44
b808c0bc19a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fermikit commit 47795b03c956d0f239aede8e27d2aa4e3c4c1d27
mvdbeek
parents:
diff changeset
45 Usage: fermi2.pl unitig [options] <in.fq>
b808c0bc19a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fermikit commit 47795b03c956d0f239aede8e27d2aa4e3c4c1d27
mvdbeek
parents:
diff changeset
46
b808c0bc19a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fermikit commit 47795b03c956d0f239aede8e27d2aa4e3c4c1d27
mvdbeek
parents:
diff changeset
47 Options: -p STR output prefix [fmdef]
b808c0bc19a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fermikit commit 47795b03c956d0f239aede8e27d2aa4e3c4c1d27
mvdbeek
parents:
diff changeset
48 -s STR approximate genome size [100m]
b808c0bc19a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fermikit commit 47795b03c956d0f239aede8e27d2aa4e3c4c1d27
mvdbeek
parents:
diff changeset
49 -2 2-pass error correction
b808c0bc19a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fermikit commit 47795b03c956d0f239aede8e27d2aa4e3c4c1d27
mvdbeek
parents:
diff changeset
50 -l INT primary read length [101]
b808c0bc19a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fermikit commit 47795b03c956d0f239aede8e27d2aa4e3c4c1d27
mvdbeek
parents:
diff changeset
51 -T INT use INT-mer for post-trimming/filtering [61]
b808c0bc19a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fermikit commit 47795b03c956d0f239aede8e27d2aa4e3c4c1d27
mvdbeek
parents:
diff changeset
52 -k INT min overlap length during unitig construction [based on -l]
b808c0bc19a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fermikit commit 47795b03c956d0f239aede8e27d2aa4e3c4c1d27
mvdbeek
parents:
diff changeset
53 -o INT min overlap length during graph cleaning [based on -l]
b808c0bc19a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fermikit commit 47795b03c956d0f239aede8e27d2aa4e3c4c1d27
mvdbeek
parents:
diff changeset
54 -m INT min overlap length for unambiguous merging [based on -l]
b808c0bc19a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fermikit commit 47795b03c956d0f239aede8e27d2aa4e3c4c1d27
mvdbeek
parents:
diff changeset
55 -t INT number of threads [4]
b808c0bc19a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fermikit commit 47795b03c956d0f239aede8e27d2aa4e3c4c1d27
mvdbeek
parents:
diff changeset
56 -E don't apply error correction
b808c0bc19a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fermikit commit 47795b03c956d0f239aede8e27d2aa4e3c4c1d27
mvdbeek
parents:
diff changeset
57
b808c0bc19a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fermikit commit 47795b03c956d0f239aede8e27d2aa4e3c4c1d27
mvdbeek
parents:
diff changeset
58 ]]></help>
b808c0bc19a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fermikit commit 47795b03c956d0f239aede8e27d2aa4e3c4c1d27
mvdbeek
parents:
diff changeset
59 <citations>
b808c0bc19a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fermikit commit 47795b03c956d0f239aede8e27d2aa4e3c4c1d27
mvdbeek
parents:
diff changeset
60 <citation type="doi">10.1093/bioinformatics/btv440</citation>
b808c0bc19a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fermikit commit 47795b03c956d0f239aede8e27d2aa4e3c4c1d27
mvdbeek
parents:
diff changeset
61 </citations>
b808c0bc19a9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/fermikit commit 47795b03c956d0f239aede8e27d2aa4e3c4c1d27
mvdbeek
parents:
diff changeset
62 </tool>