annotate trimming3.xml @ 2:621da360a155 draft

Uploaded
author czlab
date Thu, 17 May 2018 21:33:10 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
621da360a155 Uploaded
czlab
parents:
diff changeset
1 <tool id="trimming3" name="Trim 3' adapter">
621da360a155 Uploaded
czlab
parents:
diff changeset
2 <description> using FASTX Toolkit</description>
621da360a155 Uploaded
czlab
parents:
diff changeset
3
621da360a155 Uploaded
czlab
parents:
diff changeset
4 <command>
621da360a155 Uploaded
czlab
parents:
diff changeset
5 fastx_clipper -a $adapterSeq -l $discardShorterThan $discardNonclipped $discardClipped $adapterOnly $keepUnknown
621da360a155 Uploaded
czlab
parents:
diff changeset
6 #if $minAdapterAlignment.minOverlapRequired =="yes":
621da360a155 Uploaded
czlab
parents:
diff changeset
7 -M $minAdapterAlignment.minLen
621da360a155 Uploaded
czlab
parents:
diff changeset
8 #end if
621da360a155 Uploaded
czlab
parents:
diff changeset
9 -v -i $input 2>/dev/null | fastq_quality_trimmer -v -l $discardShorterThan -t $qualityThreshold -o $output
621da360a155 Uploaded
czlab
parents:
diff changeset
10 </command>
621da360a155 Uploaded
czlab
parents:
diff changeset
11
621da360a155 Uploaded
czlab
parents:
diff changeset
12 <inputs>
621da360a155 Uploaded
czlab
parents:
diff changeset
13 <param name="input" type="data" format="fastq" label="Input FASTQ file"/>
621da360a155 Uploaded
czlab
parents:
diff changeset
14
621da360a155 Uploaded
czlab
parents:
diff changeset
15 <param name="adapterSeq" type="text" value="" label="Adapter sequence (the 3' adapter will vary for different CLIP protocol variations)"/>
621da360a155 Uploaded
czlab
parents:
diff changeset
16 <param name="discardShorterThan" type="integer" value="" label="Discard sequences shorter than N nucleotides (see help below for parameter suggestion)"/>
621da360a155 Uploaded
czlab
parents:
diff changeset
17 <param name="discardNonclipped" type="boolean" truevalue="-c" falsevalue="" checked="no" label="Discard non-trimmed sequences (i.e. - keep only sequences which contained the adapter)" />
621da360a155 Uploaded
czlab
parents:
diff changeset
18 <param name="discardClipped" type="boolean" truevalue="-C" falsevalue="" checked="no" label="Discard trimmed sequences (i.e. - keep only sequences which did not contained the adapter)" />
621da360a155 Uploaded
czlab
parents:
diff changeset
19 <param name="adapterOnly" type="boolean" truevalue="-k" falsevalue="" checked="no" label="Report Adapter-Only sequences"/>
621da360a155 Uploaded
czlab
parents:
diff changeset
20 <param name="keepUnknown" type="boolean" truevalue="-n" falsevalue="" checked="yes" label="Keep sequences with unknown nucleotides"/>
621da360a155 Uploaded
czlab
parents:
diff changeset
21 <conditional name="minAdapterAlignment">
621da360a155 Uploaded
czlab
parents:
diff changeset
22 <param name="minOverlapRequired" type="select" label="Require minimum adapter alignment length of N. If less than N nucleotides aligned with the adapter - don't trim it.">
621da360a155 Uploaded
czlab
parents:
diff changeset
23 <option value="yes">Yes</option>
621da360a155 Uploaded
czlab
parents:
diff changeset
24 <option value="no" selected="True">No</option>
621da360a155 Uploaded
czlab
parents:
diff changeset
25 </param>
621da360a155 Uploaded
czlab
parents:
diff changeset
26 <when value="yes">
621da360a155 Uploaded
czlab
parents:
diff changeset
27 <param name="minLen" type="integer" value="" label="Input the length"/>
621da360a155 Uploaded
czlab
parents:
diff changeset
28 </when>
621da360a155 Uploaded
czlab
parents:
diff changeset
29 <when value="no">
621da360a155 Uploaded
czlab
parents:
diff changeset
30 </when>
621da360a155 Uploaded
czlab
parents:
diff changeset
31 </conditional>
621da360a155 Uploaded
czlab
parents:
diff changeset
32 <param name="qualityThreshold" type="integer" value="5" label="Quality threshold - nucleotides with lower quality will be trimmed (from the end of the sequence)"/>
621da360a155 Uploaded
czlab
parents:
diff changeset
33 <!--<param name="CompressOutput" type="boolean" truevalue="-z" falsevalue="" checked="no" label="Compress output with GZIP"/> -->
621da360a155 Uploaded
czlab
parents:
diff changeset
34
621da360a155 Uploaded
czlab
parents:
diff changeset
35 </inputs>
621da360a155 Uploaded
czlab
parents:
diff changeset
36
621da360a155 Uploaded
czlab
parents:
diff changeset
37 <outputs>
621da360a155 Uploaded
czlab
parents:
diff changeset
38 <data name="output" format="fastq" label="Trim 3' adapter on ${on_string} "/>
621da360a155 Uploaded
czlab
parents:
diff changeset
39 </outputs>
621da360a155 Uploaded
czlab
parents:
diff changeset
40 <help>
621da360a155 Uploaded
czlab
parents:
diff changeset
41
621da360a155 Uploaded
czlab
parents:
diff changeset
42 .. class:: infomark
621da360a155 Uploaded
czlab
parents:
diff changeset
43
621da360a155 Uploaded
czlab
parents:
diff changeset
44 **What this tool does**
621da360a155 Uploaded
czlab
parents:
diff changeset
45
621da360a155 Uploaded
czlab
parents:
diff changeset
46
621da360a155 Uploaded
czlab
parents:
diff changeset
47 This tool takes as input FASTQ files and output FASTQ files with 3' adapters and extremely low quality bases (e.g. score less than 5) removed.
621da360a155 Uploaded
czlab
parents:
diff changeset
48
621da360a155 Uploaded
czlab
parents:
diff changeset
49 It is a wrapper of fastx_clipper and fastq_quality_trimmer that are a part of the FASTX Toolkit (http://hannonlab.cshl.edu/fastx_toolkit/).
621da360a155 Uploaded
czlab
parents:
diff changeset
50
621da360a155 Uploaded
czlab
parents:
diff changeset
51 -----
621da360a155 Uploaded
czlab
parents:
diff changeset
52
621da360a155 Uploaded
czlab
parents:
diff changeset
53 **Parameter suggestion for discarding sequences**
621da360a155 Uploaded
czlab
parents:
diff changeset
54
621da360a155 Uploaded
czlab
parents:
diff changeset
55 We typically require high quality score in barcode and 15 nt of CLIP tags.
621da360a155 Uploaded
czlab
parents:
diff changeset
56 * For standard CLIP: discard sequences shorter than 20 nt (5 nt barcode + 15 nt CLIP tag).
621da360a155 Uploaded
czlab
parents:
diff changeset
57 * For BrdU CLIP: discard sequences shorter than 29 nucleotides (14 nt barcode + 15 nt CLIP tag).
621da360a155 Uploaded
czlab
parents:
diff changeset
58
621da360a155 Uploaded
czlab
parents:
diff changeset
59 </help>
621da360a155 Uploaded
czlab
parents:
diff changeset
60
621da360a155 Uploaded
czlab
parents:
diff changeset
61 </tool>