annotate fastx_renamer.xml @ 0:4ed1114bfe88 draft

Uploaded
author devteam
date Tue, 20 Aug 2013 10:50:39 -0400
parents
children defaa5ba1ee2
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
1 <tool id="cshl_fastx_renamer" name="Rename sequences" version="0.0.11" >
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
2 <description></description>
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
3 <requirements>
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
4 <requirement type="package" version="0.0.13">fastx_toolkit</requirement>
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
5 </requirements>
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
6 <command>zcat -f $input | fastx_renamer -n $TYPE -o $output -v
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
7 #if $input.ext == "fastqsanger":
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
8 -Q 33
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
9 #end if
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
10 </command>
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
11
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
12 <inputs>
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
13 <param format="fastqsolexa,fasta,fastqsanger" name="input" type="data" label="FASTQ/A Library to rename" />
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
14
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
15 <param name="TYPE" type="select" label="Rename sequence identifiers to">
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
16 <option value="SEQ">Nucleotides sequence</option>
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
17 <option value="COUNT">Numeric Counter</option>
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
18 </param>
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
19 </inputs>
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
20
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
21 <outputs>
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
22 <data format="input" name="output" metadata_source="input" />
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
23 </outputs>
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
24
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
25 <help>
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
26
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
27 **What it does**
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
28
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
29 This tool renames the sequence identifiers in a FASTQ/A file.
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
30
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
31 .. class:: infomark
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
32
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
33 Use this tool at the beginning of your workflow, as a way to keep the original sequence (before trimming, clipping, barcode-removal, etc).
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
34
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
35 --------
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
36
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
37 **Example**
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
38
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
39 The following Solexa-FASTQ file::
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
40
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
41 @CSHL_4_FC042GAMMII_2_1_517_596
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
42 GGTCAATGATGAGTTGGCACTGTAGGCACCATCAAT
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
43 +CSHL_4_FC042GAMMII_2_1_517_596
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
44 40 40 40 40 40 40 40 40 40 40 38 40 40 40 40 40 14 40 40 40 40 40 36 40 13 14 24 24 9 24 9 40 10 10 15 40
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
45
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
46 Renamed to **nucleotides sequence**::
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
47
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
48 @GGTCAATGATGAGTTGGCACTGTAGGCACCATCAAT
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
49 GGTCAATGATGAGTTGGCACTGTAGGCACCATCAAT
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
50 +GGTCAATGATGAGTTGGCACTGTAGGCACCATCAAT
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
51 40 40 40 40 40 40 40 40 40 40 38 40 40 40 40 40 14 40 40 40 40 40 36 40 13 14 24 24 9 24 9 40 10 10 15 40
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
52
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
53 Renamed to **numeric counter**::
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
54
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
55 @1
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
56 GGTCAATGATGAGTTGGCACTGTAGGCACCATCAAT
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
57 +1
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
58 40 40 40 40 40 40 40 40 40 40 38 40 40 40 40 40 14 40 40 40 40 40 36 40 13 14 24 24 9 24 9 40 10 10 15 40
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
59
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
60 ------
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
61
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
62 This tool is based on `FASTX-toolkit`__ by Assaf Gordon.
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
63
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
64 .. __: http://hannonlab.cshl.edu/fastx_toolkit/
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
65 </help>
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
66 <!-- FASTQ-to-FASTA is part of the FASTX-toolkit, by A.Gordon (gordon@cshl.edu) -->
4ed1114bfe88 Uploaded
devteam
parents:
diff changeset
67 </tool>