annotate oases_optimiser.xml @ 2:b5df930313cc draft

planemo upload for repository https://bitbucket.org/drosofff/gedtools/
author drosofff
date Mon, 22 Jun 2015 10:39:20 -0400
parents 070f9de358fc
children f08d9c814ffb
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
b5df930313cc planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents: 1
diff changeset
1 <tool id="oasesoptimiserv" name="Oases_optimiser" version="1.1.3">
0
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
2 <description>Auto optimise de novo RNA-seq Oases/Velvet assembly</description>
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
3 <requirements>
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
4 <requirement type="package" version="0.2.08_7a32460a60929b510037952ae815bb6e29b68123">oases</requirement>
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
5 </requirements>
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
6 <command interpreter="python">
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
7 oases_optimiser.py '$start_hash_length' '$end_hash_length'
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
8 '#for $i in $inputs
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
9 ${i.input}
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
10 #end for
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
11 '
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
12 '$transcripts'
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
13 </command>
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
14
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
15 <inputs>
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
16 <param label="Start Hash Length" name="start_hash_length" type="select" help="k-mer length in base pairs of the words being hashed. Shorter hash lengths (i.e. less than 31) may cause out-of-memory problems.">
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
17 <option value="11" selected="yes">11</option>
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
18 <option value="13">13</option>
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
19 <option value="15">15</option>
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
20 <option value="17">17</option>
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
21 <option value="19">19</option>
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
22 <option value="21">21</option>
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
23 <option value="23">23</option>
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
24 <option value="25">25</option>
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
25
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
26 </param>
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
27 <param label="End Hash Length" name="end_hash_length" type="select" help="k-mer length in base pairs of the words being hashed.">
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
28 <option value="25">25</option>
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
29 <option value="27">27</option>
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
30 <option value="29">29</option>
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
31 <option value="31">31</option>
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
32 <option value="33">33</option>
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
33 <option value="35">35</option>
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
34 </param>
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
35
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
36
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
37
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
38 <repeat name="inputs" title="Input Files">
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
39 <param name="input" type="data" format="fasta" label="Dataset: short reads, fasta format"/>
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
40 </repeat>
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
41 </inputs>
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
42
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
43 <outputs>
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
44 <data format="fasta" name="transcripts" label="${tool.name} on ${on_string}: Denovo assembled transcripts"/>
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
45 </outputs>
1
070f9de358fc planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents: 0
diff changeset
46 <tests>
070f9de358fc planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents: 0
diff changeset
47 <test>
070f9de358fc planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents: 0
diff changeset
48 <param name="input" value="input.fa" ftype="fasta"/>
070f9de358fc planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents: 0
diff changeset
49 <param name="start_hash_length" value="15" />
070f9de358fc planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents: 0
diff changeset
50 <param name="end_hash_length" value="35" />
070f9de358fc planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents: 0
diff changeset
51 <output name="transcripts" file="output.fa"/>
070f9de358fc planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents: 0
diff changeset
52 </test>
070f9de358fc planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents: 0
diff changeset
53 </tests>
0
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
54
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
55 <help>
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
56 **Oases Optimiser Overview**
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
57
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
58 Oases_ is a de novo transcriptome assembler specially designed to work with short reads. It is an extension of Velvet developed by Daniel Zerbino and Ewan Birney at the European Bioinformatics Institute (EMBL-EBI), near Cambridge, in the United Kingdom.
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
59
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
60 Provide all the information about insert lengths and their standard deviation as
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
61 possible (identical to Velvet). In the advanced oases options you should set the -ins_length flag when using paired-end reads (e.g. -ins_length 200 -ins_length_sd 100). If you do not do this, then paired-end information will not be used by Oases!
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
62
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
63 ----------------------------------------------------------------------------------
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
64
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
65 Oases produces a number of output files, which correspond to the different algorithms
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
66 being run succesively on the data. In the above example, you would find:
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
67
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
68 transcripts.fa
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
69 A FASTA file containing the transcripts imputed directly from trivial
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
70 clusters of contigs (loci with less than two transcripts and Confidence Values = 1)
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
71 and the highly expressed transcripts imputed by dynamic
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
72 programming (loci with more than 2 transcripts and Confidence Values less than 1).
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
73
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
74 splicing_events.txt
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
75 A hybrid file which describes the contigs contained in each locus in FASTA
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
76 format, interlaced with one line descriptions of splicing events using the
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
77 AStalavista nomenclature*.
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
78
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
79 Read the Oases `documentation`__ for details on using the Oases Assembler.
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
80
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
81 .. _Velvet: http://www.ebi.ac.uk/~zerbino/oases/
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
82
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
83 .. __: http://www.ebi.ac.uk/~zerbino/oases/Manual.txt
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
84
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
85 ------
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
86
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
87 **Other outputs (as per Velvet)**
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
88
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
89
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
90 **Contigs**
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
91
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
92 The *contigs.fa* file.
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
93 This fasta file contains the sequences of the contigs longer than 2k, where k is the word-length used in velveth. If you have specified a min contig lgth threshold, then the contigs shorter than that value are omitted.
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
94 Note that the length and coverage information provided in the header of each contig should therefore be understood in k-mers and in k-mer coverage (cf. 5.1) respectively.
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
95 The N's in the sequence correspond to gaps between scaffolded contigs. The number of N's corresponds to the estimated length of the gap. For reasons of compatibility with the archives, any gap shorter than 10bp is represented by a sequence of 10 N's.
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
96
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
97 **Stats**
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
98
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
99 The *stats.txt* file.
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
100 This file is a simple tabbed-delimited description of the nodes. The column names are pretty much self-explanatory. Note however that node lengths are given in k-mers. To obtain the length in nucleotides of each node you simply need to add k - 1, where k is the word-length used in velveth.
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
101 The in and out columns correspond to the number of arcs on the 5' and 3' ends of the contig respectively.
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
102 The coverages in columns short1 cov, short1 Ocov, short2 cov, and short2 Ocov are provided in k-mer coverage (5.1).
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
103 Also, the difference between # cov and # Ocov is the way these values are computed. In the first count, slightly divergent sequences are added to the coverage tally. However, in the second, stricter count, only the sequences which map perfectly onto the consensus sequence are taken into account.
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
104
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
105 **LastGraph**
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
106
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
107 The *LastGraph* file.
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
108 This file describes in its entirety the graph produced by Velvet.
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
109
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
110 **AMOS.afg**
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
111 The *velvet_asm.afg* file.
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
112 This file is mainly designed to be read by the open-source AMOS genome assembly package. Nonetheless, a number of programs are available to transform this kind of file into other assembly file formats (namely ACE, TIGR, Arachne and Celera). See http://amos.sourceforge.net/ for more information.
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
113 The file describes all the contigs contained in the contigs.fa file (cf 4.2.1).
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
114
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
115 **Advanced options**
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
116 -ins_length integer : expected distance between two paired-end reads in the first short-read dataset (default: no read pairing)
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
117 -ins_length2 integer : expected distance between two paired-end reads in the second short-read dataset (default: no read pairing)
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
118 -ins_length_long integer : expected distance between two long paired-end reads (default: no read pairing)
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
119 -ins_length*_sd integer : est. standard deviation of respective dataset (default: 10% of corresponding length)
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
120 -scaffolding yes|no : scaffolding of contigs used paired end information (default: on)
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
121 -max_branch_length integer : maximum length in base pair of bubble (default: 100)
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
122 -max_divergence floating-point : maximum divergence rate between two branches in a bubble (default: 0.2)
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
123 -max_gap_count integer : maximum number of gaps allowed in the alignment of the two branches of a bubble (default: 3)
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
124 -min_pair_count integer : minimum number of paired end connections to justify the scaffolding of two long contigs (default: 10)
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
125 -max_coverage floating point : removal of high coverage nodes AFTER tour bus (default: no removal)
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
126 -long_mult_cutoff int : minimum number of long reads required to merge contigs (default: 2)
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
127 -min_trans_length
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
128 simple threshold on output transcript length
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
129 -cov_cutoff
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
130 minimum number of times a k-mer has to be observed to be used in the
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
131 assembly (just like in Velvet) [default=3]
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
132 -min_pair_cov
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
133 minimum number of times two contigs must be connected by reads or read pairs to be clustered together [default=4]
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
134 -paired_cutoff
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
135 minimum ratio between the numbers of observed and expected connecting
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
136 read pairs between two contigs [default=0.1]
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
137
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
138
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
139
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
140 **Hash Length**
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
141
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
142 The hash length, also known as k-mer length, corresponds to the length, in base pairs, of the words being hashed.
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
143
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
144 The hash length is the length of the k-mers being entered in the hash table. Firstly, you must observe three technical constraints::
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
145
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
146 # it must be an odd number, to avoid palindromes. If you put in an even number, Velvet will just decrement it and proceed.
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
147 # it must be below or equal to MAXKMERHASH length (cf. 2.3.3, by default 31bp), because it is stored on 64 bits
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
148 # it must be strictly inferior to read length, otherwise you simply will not observe any overlaps between reads, for obvious reasons.
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
149
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
150 Now you still have quite a lot of possibilities. As is often the case, it's a trade- off between specificity and sensitivity. Longer kmers bring you more specificity (i.e. less spurious overlaps) but lowers coverage (cf. below). . . so there's a sweet spot to be found with time and experience.
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
151 We like to think in terms of "k-mer coverage", i.e. how many times has a k-mer been seen among the reads. The relation between k-mer coverage Ck and standard (nucleotide-wise) coverage C is Ck = C # (L - k + 1)/L where k is your hash length, and L you read length.
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
152 Experience shows that this kmer coverage should be above 10 to start getting decent results. If Ck is above 20, you might be "wasting" coverage. Experience also shows that empirical tests with different values for k are not that costly to run! VelvetOptimiser automates these tests for you.
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
153
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
154
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
155 **Velvetg options**
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
156
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
157
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
158
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
159 **Input Files**
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
160
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
161 This Velvet wrapper works only with fasta format, non-paired-end reads.
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
162
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
163 Supported file formats are::
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
164
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
165 fasta
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
166
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
167 Read categories are::
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
168
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
169 short (default)
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
170
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
171 </help>
eedbe32980bb planemo upload for repository https://bitbucket.org/drosofff/gedtools/
drosofff
parents:
diff changeset
172 </tool>