annotate fastx_trimmer.xml @ 2:97f0b63ae7cf draft

planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
author devteam
date Tue, 13 Oct 2015 12:42:13 -0400
parents 0288c4b3a53f
children 9081fe62bd56
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
a7d22d34ec70 Uploaded tool tarball.
devteam
parents:
diff changeset
1 <tool id="cshl_fastx_trimmer" version="1.0.0" name="Trim sequences">
2
97f0b63ae7cf planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
2 <description></description>
0
a7d22d34ec70 Uploaded tool tarball.
devteam
parents:
diff changeset
3 <requirements>
a7d22d34ec70 Uploaded tool tarball.
devteam
parents:
diff changeset
4 <requirement type="package" version="0.0.13">fastx_toolkit</requirement>
a7d22d34ec70 Uploaded tool tarball.
devteam
parents:
diff changeset
5 </requirements>
2
97f0b63ae7cf planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
6 <command>
97f0b63ae7cf planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
7 <![CDATA[
97f0b63ae7cf planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
8 zcat -f < '$input' | fastx_trimmer -v -f $first -l $last -o '$output'
0
a7d22d34ec70 Uploaded tool tarball.
devteam
parents:
diff changeset
9 #if $input.ext == "fastqsanger":
2
97f0b63ae7cf planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
10 -Q 33
0
a7d22d34ec70 Uploaded tool tarball.
devteam
parents:
diff changeset
11 #end if
2
97f0b63ae7cf planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
12 ]]>
97f0b63ae7cf planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
13 </command>
0
a7d22d34ec70 Uploaded tool tarball.
devteam
parents:
diff changeset
14
2
97f0b63ae7cf planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
15 <inputs>
97f0b63ae7cf planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
16 <param format="fasta,fastqsolexa,fastqsanger" name="input" type="data" label="Library to clip" />
0
a7d22d34ec70 Uploaded tool tarball.
devteam
parents:
diff changeset
17
2
97f0b63ae7cf planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
18 <param name="first" type="integer" value="1">
97f0b63ae7cf planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
19 <label>First base to keep</label>
97f0b63ae7cf planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
20 </param>
0
a7d22d34ec70 Uploaded tool tarball.
devteam
parents:
diff changeset
21
2
97f0b63ae7cf planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
22 <param name="last" type="integer" value="21">
97f0b63ae7cf planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
23 <label>Last base to keep</label>
97f0b63ae7cf planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
24 </param>
97f0b63ae7cf planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
25 </inputs>
97f0b63ae7cf planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
26 <outputs>
97f0b63ae7cf planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
27 <data format_source="input" name="output" metadata_source="input" />
97f0b63ae7cf planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
28 </outputs>
97f0b63ae7cf planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
29 <tests>
97f0b63ae7cf planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
30 <test>
97f0b63ae7cf planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
31 <!-- Trim a FASTA file - remove first four bases (e.g. a barcode) -->
97f0b63ae7cf planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
32 <param name="input" value="fastx_trimmer1.fasta" />
97f0b63ae7cf planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
33 <param name="first" value="5"/>
97f0b63ae7cf planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
34 <param name="last" value="36"/>
97f0b63ae7cf planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
35 <output name="output" ftype="fasta" file="fastx_trimmer1.out" />
97f0b63ae7cf planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
36 </test>
97f0b63ae7cf planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
37 <test>
97f0b63ae7cf planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
38 <!-- Trim a FASTQ file - remove last 9 bases (e.g. keep only miRNA length sequences) -->
97f0b63ae7cf planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
39 <param name="input" value="fastx_trimmer2.fastq" ftype="fastqsolexa"/>
97f0b63ae7cf planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
40 <param name="first" value="1"/>
97f0b63ae7cf planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
41 <param name="last" value="27"/>
97f0b63ae7cf planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
42 <output name="output" ftype="fastqsolexa" file="fastx_trimmer2.out" />
97f0b63ae7cf planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
43 </test>
97f0b63ae7cf planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
44 </tests>
97f0b63ae7cf planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
45 <help>
0
a7d22d34ec70 Uploaded tool tarball.
devteam
parents:
diff changeset
46 **What it does**
a7d22d34ec70 Uploaded tool tarball.
devteam
parents:
diff changeset
47
a7d22d34ec70 Uploaded tool tarball.
devteam
parents:
diff changeset
48 This tool trims (cut bases from) sequences in a FASTA/Q file.
2
97f0b63ae7cf planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
49
0
a7d22d34ec70 Uploaded tool tarball.
devteam
parents:
diff changeset
50 --------
a7d22d34ec70 Uploaded tool tarball.
devteam
parents:
diff changeset
51
a7d22d34ec70 Uploaded tool tarball.
devteam
parents:
diff changeset
52 **Example**
a7d22d34ec70 Uploaded tool tarball.
devteam
parents:
diff changeset
53
a7d22d34ec70 Uploaded tool tarball.
devteam
parents:
diff changeset
54 Input Fasta file (with 36 bases in each sequences)::
a7d22d34ec70 Uploaded tool tarball.
devteam
parents:
diff changeset
55
a7d22d34ec70 Uploaded tool tarball.
devteam
parents:
diff changeset
56 >1-1
a7d22d34ec70 Uploaded tool tarball.
devteam
parents:
diff changeset
57 TATGGTCAGAAACCATATGCAGAGCCTGTAGGCACC
a7d22d34ec70 Uploaded tool tarball.
devteam
parents:
diff changeset
58 >2-1
a7d22d34ec70 Uploaded tool tarball.
devteam
parents:
diff changeset
59 CAGCGAGGCTTTAATGCCATTTGGCTGTAGGCACCA
2
97f0b63ae7cf planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
60
0
a7d22d34ec70 Uploaded tool tarball.
devteam
parents:
diff changeset
61
a7d22d34ec70 Uploaded tool tarball.
devteam
parents:
diff changeset
62 Trimming with First=1 and Last=21, we get a FASTA file with 21 bases in each sequences (starting from the first base)::
a7d22d34ec70 Uploaded tool tarball.
devteam
parents:
diff changeset
63
a7d22d34ec70 Uploaded tool tarball.
devteam
parents:
diff changeset
64 >1-1
a7d22d34ec70 Uploaded tool tarball.
devteam
parents:
diff changeset
65 TATGGTCAGAAACCATATGCA
a7d22d34ec70 Uploaded tool tarball.
devteam
parents:
diff changeset
66 >2-1
a7d22d34ec70 Uploaded tool tarball.
devteam
parents:
diff changeset
67 CAGCGAGGCTTTAATGCCATT
a7d22d34ec70 Uploaded tool tarball.
devteam
parents:
diff changeset
68
a7d22d34ec70 Uploaded tool tarball.
devteam
parents:
diff changeset
69 Trimming with First=6 and Last=10, will generate a FASTA file with 5 bases (bases 6,7,8,9,10) in each sequences::
a7d22d34ec70 Uploaded tool tarball.
devteam
parents:
diff changeset
70
a7d22d34ec70 Uploaded tool tarball.
devteam
parents:
diff changeset
71 >1-1
a7d22d34ec70 Uploaded tool tarball.
devteam
parents:
diff changeset
72 TCAGA
a7d22d34ec70 Uploaded tool tarball.
devteam
parents:
diff changeset
73 >2-1
a7d22d34ec70 Uploaded tool tarball.
devteam
parents:
diff changeset
74 AGGCT
2
97f0b63ae7cf planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
75
0
a7d22d34ec70 Uploaded tool tarball.
devteam
parents:
diff changeset
76 ------
a7d22d34ec70 Uploaded tool tarball.
devteam
parents:
diff changeset
77
a7d22d34ec70 Uploaded tool tarball.
devteam
parents:
diff changeset
78 This tool is based on `FASTX-toolkit`__ by Assaf Gordon.
a7d22d34ec70 Uploaded tool tarball.
devteam
parents:
diff changeset
79
a7d22d34ec70 Uploaded tool tarball.
devteam
parents:
diff changeset
80 .. __: http://hannonlab.cshl.edu/fastx_toolkit/
2
97f0b63ae7cf planemo upload commit 33927a87ba2eee9bf0ecdd376a66241b17b3d734
devteam
parents: 1
diff changeset
81 </help>
0
a7d22d34ec70 Uploaded tool tarball.
devteam
parents:
diff changeset
82 <!-- FASTX-Trimmer is part of the FASTX-toolkit, by A.Gordon (gordon@cshl.edu) -->
a7d22d34ec70 Uploaded tool tarball.
devteam
parents:
diff changeset
83 </tool>