annotate fastx_clipper.xml @ 0:2fe2d2b9e8e4 draft

Uploaded tool tarball.
author devteam
date Wed, 25 Sep 2013 11:07:38 -0400
parents
children 8192b4014977
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
1 <tool id="cshl_fastx_clipper" name="Clip" version="1.0.1" >
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
2 <description>adapter sequences</description>
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
3 <requirements>
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
4 <requirement type="package" version="0.0.13">fastx_toolkit</requirement>
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
5 </requirements>
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
6 <command>
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
7 zcat -f $input | fastx_clipper -l $minlength -a $clip_source.clip_sequence -d $keepdelta -o $output -v $KEEP_N $DISCARD_OPTIONS
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
8 #if $input.ext == "fastqsanger":
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
9 -Q 33
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
10 #end if
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
11 </command>
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
12
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
13 <inputs>
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
14 <param format="fasta,fastqsanger,fastqsolexa,fastqillumina" name="input" type="data" label="Library to clip" />
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
15
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
16 <param name="minlength" size="4" type="integer" value="15">
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
17 <label>Minimum sequence length (after clipping, sequences shorter than this length will be discarded)</label>
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
18 </param>
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
19
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
20 <conditional name="clip_source">
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
21 <param name="clip_source_list" type="select" label="Source">
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
22 <option value="prebuilt" selected="true">Standard (select from the list below)</option>
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
23 <option value="user">Enter custom sequence</option>
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
24 </param>
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
25
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
26 <when value="user">
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
27 <param name="clip_sequence" size="30" label="Enter custom clipping sequence" type="text" value="AATTGGCC" />
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
28 </when>
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
29
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
30 <when value="prebuilt">
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
31 <param name="clip_sequence" type="select" label="Choose Adapter">
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
32 <options from_file="fastx_clipper_sequences.txt">
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
33 <column name="name" index="1"/>
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
34 <column name="value" index="0"/>
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
35 </options>
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
36 </param>
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
37 </when>
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
38 </conditional>
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
39
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
40 <param name="keepdelta" size="2" type="integer" value="0">
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
41 <label>enter non-zero value to keep the adapter sequence and x bases that follow it</label>
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
42 <help>use this for hairpin barcoding. keep at 0 unless you know what you're doing.</help>
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
43 </param>
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
44
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
45 <param name="KEEP_N" type="select" label="Discard sequences with unknown (N) bases">
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
46 <option value="">Yes</option>
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
47 <option value="-n">No</option>
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
48 </param>
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
49
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
50 <param name="DISCARD_OPTIONS" type="select" label="Output options">
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
51 <option value="-c">Output only clipped sequences (i.e. sequences which contained the adapter)</option>
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
52 <option value="-C">Output only non-clipped sequences (i.e. sequences which did not contained the adapter)</option>
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
53 <option value="">Output both clipped and non-clipped sequences</option>
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
54 </param>
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
55
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
56 </inputs>
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
57 <!--
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
58 #functional test with param value starting with - fails.
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
59 -->
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
60 <tests>
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
61 <test>
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
62 <param name="input" value="fastx_clipper1.fastq" ftype="fastqsolexa"/>
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
63 <param name="maxmismatches" value="2" />
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
64 <param name="minlength" value="15" />
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
65 <param name="clip_source_list" value="user" />
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
66 <param name="clip_sequence" value="CAATTGGTTAATCCCCCTATATA" />
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
67 <param name="keepdelta" value="0" />
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
68 <param name="KEEP_N" value="+-n" />
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
69 <param name="DISCARD_OPTIONS" value="+-c" />
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
70 <output name="output" file="fastx_clipper1a.out" />
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
71 </test>
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
72 </tests>
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
73 <outputs>
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
74 <data format="input" name="output" metadata_source="input" />
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
75 </outputs>
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
76
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
77 <help>
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
78 **What it does**
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
79
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
80 This tool clips adapters from the 3'-end of the sequences in a FASTA/FASTQ file.
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
81
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
82 --------
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
83
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
84
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
85 **Clipping Illustration:**
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
86
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
87 .. image:: ${static_path}/fastx_icons/fastx_clipper_illustration.png
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
88
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
89
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
90
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
91
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
92
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
93
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
94
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
95
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
96 **Clipping Example:**
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
97
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
98 .. image:: ${static_path}/fastx_icons/fastx_clipper_example.png
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
99
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
100
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
101
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
102 **In the above example:**
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
103
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
104 * Sequence no. 1 was discarded since it wasn't clipped (i.e. didn't contain the adapter sequence). (**Output** parameter).
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
105 * Sequence no. 5 was discarded --- it's length (after clipping) was shorter than 15 nt (**Minimum Sequence Length** parameter).
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
106
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
107
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
108
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
109
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
110 ------
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
111
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
112 This tool is based on `FASTX-toolkit`__ by Assaf Gordon.
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
113
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
114 .. __: http://hannonlab.cshl.edu/fastx_toolkit/
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
115
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
116 </help>
2fe2d2b9e8e4 Uploaded tool tarball.
devteam
parents:
diff changeset
117 </tool>