annotate short_reads_trim_seq.xml @ 0:8c0b907e6e5b draft

Imported from capsule None
author devteam
date Mon, 19 May 2014 10:59:57 -0400
parents
children ece3c79e81ae
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
1 <tool id="trim_reads" name="Select high quality segments" version="1.0.0">
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
2 <description></description>
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
3
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
4 <command interpreter="python">
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
5 short_reads_trim_seq.py $trim $length $output1 $input1 $input2 $sequencing_method_choice.input3
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
6 </command>
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
7 <inputs>
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
8 <page>
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
9 <param name="input1" type="data" format="fasta" label="Reads" />
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
10 <param name="input2" type="data" format="qualsolexa,qual454" label="Quality scores" />
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
11 <param name="trim" type="integer" size="5" value="20" label="Minimal quality score" help="bases scoring below this value will trigger splitting"/>
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
12 <param name="length" type="integer" size="5" value="100" label="Minimal length of contiguous segment" help="report all high quality segments above this length. Setting this option to '0' will cause the program to return a single longest run of high quality bases per read" />
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
13 <conditional name="sequencing_method_choice">
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
14 <param name="sequencer" type="select" label="Select technology">
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
15 <option value="454">Roche (454) or ABI SOLiD</option>
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
16 <option value="Solexa">Illumina (Solexa)</option>
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
17 </param>
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
18 <when value="454">
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
19 <param name="input3" type="select" label="Low quality bases in homopolymers" help="if set to 'DO NOT trigger splitting' the program will not count low quality bases that are within or adjacent to homonucleotide runs. This will significantly reduce fragmentation of 454 data">
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
20 <option value="yes">DO NOT trigger splitting </option>
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
21 <option value="no">trigger splitting</option>
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
22 </param>
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
23 </when>
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
24 <when value="Solexa">
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
25 <param name="input3" type="integer" size="5" value="0" label="Restrict length of each read to" help="('0' = do not trim) The quality of Solexa reads drops towards the end. This option allows selecting the specified number of nucleotides from the beginning and then running the tool." />
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
26 </when>
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
27 </conditional>
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
28 </page>
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
29 </inputs>
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
30
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
31 <outputs>
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
32 <data name="output1" format="fasta" />
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
33 </outputs>
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
34
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
35 <tests>
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
36 <test>
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
37 <param name="sequencer" value="454" />
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
38 <param name="input1" value="454.fasta" ftype="fasta" />
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
39 <param name="input2" value="454.qual" ftype="qual454" />
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
40 <param name="input3" value="no" />
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
41 <param name="trim" value="20" />
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
42 <param name="length" value="0" />
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
43 <output name="output1" file="short_reads_trim_seq_out1.fasta" />
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
44 </test>
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
45 <test>
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
46 <param name="sequencer" value="Solexa" />
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
47 <param name="input1" value="solexa.fasta" ftype="fasta" />
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
48 <param name="input2" value="solexa.qual" ftype="qualsolexa" />
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
49 <param name="input3" value="0" />
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
50 <param name="trim" value="20" />
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
51 <param name="length" value="0" />
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
52 <output name="output1" file="short_reads_trim_seq_out2.fasta" />
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
53 </test>
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
54 </tests>
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
55
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
56 <help>
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
57
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
58 .. class:: warningmark
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
59
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
60 To use this tool, your dataset needs to be in the *Quality Score* format. Click the pencil icon next to your dataset to set the datatype to *Quality Score* (see below for examples).
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
61
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
62 -----
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
63
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
64 **What it does**
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
65
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
66 This tool finds high quality segments within sequencing reads generated by by Roche (454), Illumina (Solexa), or ABI SOLiD machines.
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
67
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
68 -----
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
69
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
70 **Example**
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
71
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
72
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
73 Suppose this is your sequencing read::
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
74
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
75 5'---------*-------------*------**----3'
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
76
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
77 where **dashes** (-) are HIGH quality bases (above 20) and **asterisks** (*) are LOW quality bases (below 20). If the **Minimal length of contiguous segment** is set to **5** (of course, only for the purposes of this example), the tool will return::
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
78
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
79 5'---------
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
80 -------------
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
81 -------
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
82
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
83 you can see that the tool simply splits the read on low quality bases and then returns all segments longer than 5. **Note**, that the output of this tool will likely contain higher number of shorter sequences compared to the original input. If we set the **Minimal length of contiguous segment** to **0**, the tool will only return the single longest segment::
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
84
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
85 -------------
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
86
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
87
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
88
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
89
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
90
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
91
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
92 </help>
8c0b907e6e5b Imported from capsule None
devteam
parents:
diff changeset
93 </tool>