annotate pyCRAC/pyFastqDuplicateRemover.xml @ 1:7c9574213c0a draft default tip

Uploaded
author swebb
date Thu, 20 Jun 2013 12:13:43 -0400
parents 19b20927172d
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
19b20927172d Uploaded
swebb
parents:
diff changeset
1 <tool id ="pyFastqDuplicateRemover" name="pyFastqDuplicateRemover">
19b20927172d Uploaded
swebb
parents:
diff changeset
2 <requirements>
19b20927172d Uploaded
swebb
parents:
diff changeset
3 <requirement type="package">pyCRAC</requirement>
19b20927172d Uploaded
swebb
parents:
diff changeset
4 </requirements>
19b20927172d Uploaded
swebb
parents:
diff changeset
5 <command interpreter="perl">
19b20927172d Uploaded
swebb
parents:
diff changeset
6 pyFastqDuplicateRemover.pl
19b20927172d Uploaded
swebb
parents:
diff changeset
7 -f $ftype.f
19b20927172d Uploaded
swebb
parents:
diff changeset
8 #if $ftype.reverse.rev == "yes":
19b20927172d Uploaded
swebb
parents:
diff changeset
9 -r=$ftype.reverse.r
19b20927172d Uploaded
swebb
parents:
diff changeset
10 --out2 $out2
19b20927172d Uploaded
swebb
parents:
diff changeset
11 #end if#
19b20927172d Uploaded
swebb
parents:
diff changeset
12 -o $out
19b20927172d Uploaded
swebb
parents:
diff changeset
13 --id $out.id
19b20927172d Uploaded
swebb
parents:
diff changeset
14 </command>
19b20927172d Uploaded
swebb
parents:
diff changeset
15 <version_command>pyFastqDuplicateRemover.py --version</version_command>
19b20927172d Uploaded
swebb
parents:
diff changeset
16 <inputs>
19b20927172d Uploaded
swebb
parents:
diff changeset
17 <conditional name="ftype">
19b20927172d Uploaded
swebb
parents:
diff changeset
18 <param name="type" type="select" label="File type">
19b20927172d Uploaded
swebb
parents:
diff changeset
19 <option value="fastq" selected="true">FASTQ</option>
19b20927172d Uploaded
swebb
parents:
diff changeset
20 <option value="fasta">FASTA</option>
19b20927172d Uploaded
swebb
parents:
diff changeset
21 </param>
19b20927172d Uploaded
swebb
parents:
diff changeset
22 <when value="fastq">
19b20927172d Uploaded
swebb
parents:
diff changeset
23 <param format="fastq" name="f" type="data" label="FastQ File -f" help="FastQ format" />
19b20927172d Uploaded
swebb
parents:
diff changeset
24 <conditional name="reverse">
19b20927172d Uploaded
swebb
parents:
diff changeset
25 <param name="rev" type="select" label="Add a reverse or paired FastQ file">
19b20927172d Uploaded
swebb
parents:
diff changeset
26 <option value="no" selected="true">NO</option>
19b20927172d Uploaded
swebb
parents:
diff changeset
27 <option value="yes">YES</option>
19b20927172d Uploaded
swebb
parents:
diff changeset
28 </param>
19b20927172d Uploaded
swebb
parents:
diff changeset
29 <when value="yes">
19b20927172d Uploaded
swebb
parents:
diff changeset
30 <param format="fastq" name="r" type="data" label="Reverse FastQ File -f" help="FastQ format" />
19b20927172d Uploaded
swebb
parents:
diff changeset
31 </when>
19b20927172d Uploaded
swebb
parents:
diff changeset
32 <when value="no">
19b20927172d Uploaded
swebb
parents:
diff changeset
33 </when>
19b20927172d Uploaded
swebb
parents:
diff changeset
34 </conditional>
19b20927172d Uploaded
swebb
parents:
diff changeset
35 </when>
19b20927172d Uploaded
swebb
parents:
diff changeset
36 <when value="fasta">
19b20927172d Uploaded
swebb
parents:
diff changeset
37 <param format="fasta" name="f" type="data" label="FastA File -f" help="FastA format" />
19b20927172d Uploaded
swebb
parents:
diff changeset
38 <conditional name="reverse">
19b20927172d Uploaded
swebb
parents:
diff changeset
39 <param name="rev" type="select" label="Add a reverse or paired FastA file">
19b20927172d Uploaded
swebb
parents:
diff changeset
40 <option value="no" selected="true">NO</option>
19b20927172d Uploaded
swebb
parents:
diff changeset
41 <option value="yes">YES</option>
19b20927172d Uploaded
swebb
parents:
diff changeset
42 </param>
19b20927172d Uploaded
swebb
parents:
diff changeset
43 <when value="yes">
19b20927172d Uploaded
swebb
parents:
diff changeset
44 <param format="fasta" name="r" type="data" label="Reverse FastA File -f" help="FastA format" />
19b20927172d Uploaded
swebb
parents:
diff changeset
45 </when>
19b20927172d Uploaded
swebb
parents:
diff changeset
46 <when value="no">
19b20927172d Uploaded
swebb
parents:
diff changeset
47 </when>
19b20927172d Uploaded
swebb
parents:
diff changeset
48 </conditional>
19b20927172d Uploaded
swebb
parents:
diff changeset
49 </when>
19b20927172d Uploaded
swebb
parents:
diff changeset
50 </conditional>
19b20927172d Uploaded
swebb
parents:
diff changeset
51 <param name="label" type="text" format="txt" size="30" value="pyFastqDuplicateRemover" label="Enter output file label -o" />
19b20927172d Uploaded
swebb
parents:
diff changeset
52 </inputs>
19b20927172d Uploaded
swebb
parents:
diff changeset
53 <outputs>
19b20927172d Uploaded
swebb
parents:
diff changeset
54 <data format="fasta" name="out" label="${label.value}.fasta"/>
19b20927172d Uploaded
swebb
parents:
diff changeset
55 <data format="fasta" name="out2" label="${label.value}_reverse.fasta">
19b20927172d Uploaded
swebb
parents:
diff changeset
56 <filter>ftype['reverse']['rev'] == "yes"</filter>
19b20927172d Uploaded
swebb
parents:
diff changeset
57 </data>
19b20927172d Uploaded
swebb
parents:
diff changeset
58 </outputs>
19b20927172d Uploaded
swebb
parents:
diff changeset
59 <help>
19b20927172d Uploaded
swebb
parents:
diff changeset
60
19b20927172d Uploaded
swebb
parents:
diff changeset
61 .. class:: infomark
19b20927172d Uploaded
swebb
parents:
diff changeset
62
19b20927172d Uploaded
swebb
parents:
diff changeset
63 **pyFastqDuplicateRemover**
19b20927172d Uploaded
swebb
parents:
diff changeset
64
19b20927172d Uploaded
swebb
parents:
diff changeset
65 pyFastqDuplicateRemover is part of the pyCRAC_ package. Removes identical sequences from fastq and fasta files and returns a fasta file with collapsed data.
19b20927172d Uploaded
swebb
parents:
diff changeset
66
19b20927172d Uploaded
swebb
parents:
diff changeset
67 Can also process paired-end data.
19b20927172d Uploaded
swebb
parents:
diff changeset
68
19b20927172d Uploaded
swebb
parents:
diff changeset
69 **Examples**
19b20927172d Uploaded
swebb
parents:
diff changeset
70
19b20927172d Uploaded
swebb
parents:
diff changeset
71 Unprocessed fastq data with six random nucleotides at 5' end of the read::
19b20927172d Uploaded
swebb
parents:
diff changeset
72
19b20927172d Uploaded
swebb
parents:
diff changeset
73 @FCC102EACXX:3:1101:3231:2110#TGACCAAT/1
19b20927172d Uploaded
swebb
parents:
diff changeset
74 GCGCCTGCCAATTCCATCGTAATGATTAATAGGGACGGTCGGGGGCATC
19b20927172d Uploaded
swebb
parents:
diff changeset
75 +
19b20927172d Uploaded
swebb
parents:
diff changeset
76 bb_ceeeegggggiiiiiifghiihiihiiiiiiiiiifggfhiecccc
19b20927172d Uploaded
swebb
parents:
diff changeset
77
19b20927172d Uploaded
swebb
parents:
diff changeset
78 After pyBarcodeFilter::
19b20927172d Uploaded
swebb
parents:
diff changeset
79
19b20927172d Uploaded
swebb
parents:
diff changeset
80 @FCC102EACXX:3:1101:3231:2110#TGACCAAT/1##GCGCCT
19b20927172d Uploaded
swebb
parents:
diff changeset
81 TCCATCGTAATGATTAATAGGGACGGTCGGGGGCATC
19b20927172d Uploaded
swebb
parents:
diff changeset
82 +
19b20927172d Uploaded
swebb
parents:
diff changeset
83 giiiiiifghiihiihiiiiiiiiiifggfhiecccc
19b20927172d Uploaded
swebb
parents:
diff changeset
84
19b20927172d Uploaded
swebb
parents:
diff changeset
85 This entry is printed to the NNNNNNGCCAAT barcode file.
19b20927172d Uploaded
swebb
parents:
diff changeset
86
19b20927172d Uploaded
swebb
parents:
diff changeset
87 After pyFastqDuplicateRemover::
19b20927172d Uploaded
swebb
parents:
diff changeset
88
19b20927172d Uploaded
swebb
parents:
diff changeset
89 >1_GCGCCT_5/1
19b20927172d Uploaded
swebb
parents:
diff changeset
90 TCCATCGTAATGATTAATAGGGACGGTCGGGGGCATC
19b20927172d Uploaded
swebb
parents:
diff changeset
91
19b20927172d Uploaded
swebb
parents:
diff changeset
92 The '1' indicates that this is the first unique cDNA in the data
19b20927172d Uploaded
swebb
parents:
diff changeset
93 GCGCCT is the random barcode sequence
19b20927172d Uploaded
swebb
parents:
diff changeset
94 the '5' indicates that 5 reads were found with identical read and random barcode sequences
19b20927172d Uploaded
swebb
parents:
diff changeset
95 the '/1' indicates that the seqeuence originates from the forward sequencing reaction
19b20927172d Uploaded
swebb
parents:
diff changeset
96
19b20927172d Uploaded
swebb
parents:
diff changeset
97 .. _pyCRAC: http://sandergranneman.bio.ed.ac.uk/Granneman_Lab/pyCRAC_software.html
19b20927172d Uploaded
swebb
parents:
diff changeset
98
19b20927172d Uploaded
swebb
parents:
diff changeset
99 ------
19b20927172d Uploaded
swebb
parents:
diff changeset
100
19b20927172d Uploaded
swebb
parents:
diff changeset
101 **Parameter list**
19b20927172d Uploaded
swebb
parents:
diff changeset
102
19b20927172d Uploaded
swebb
parents:
diff changeset
103 Options::
19b20927172d Uploaded
swebb
parents:
diff changeset
104
19b20927172d Uploaded
swebb
parents:
diff changeset
105 -f FILE, --input_file=FILE
19b20927172d Uploaded
swebb
parents:
diff changeset
106 name of the FASTQ or FASTA input file
19b20927172d Uploaded
swebb
parents:
diff changeset
107
19b20927172d Uploaded
swebb
parents:
diff changeset
108 -r FILE, --reverse_input_file=FILE
19b20927172d Uploaded
swebb
parents:
diff changeset
109 name of the paired (or reverse) FASTQ or FASTA input file
19b20927172d Uploaded
swebb
parents:
diff changeset
110
19b20927172d Uploaded
swebb
parents:
diff changeset
111 -o FILE, --output_file=FILE
19b20927172d Uploaded
swebb
parents:
diff changeset
112 Provide the path and name of the fastq or fasta output file. Default is standard output.
19b20927172d Uploaded
swebb
parents:
diff changeset
113 For paired-end data just provide a file name without file extension (!)
19b20927172d Uploaded
swebb
parents:
diff changeset
114 </help>
19b20927172d Uploaded
swebb
parents:
diff changeset
115 </tool>
19b20927172d Uploaded
swebb
parents:
diff changeset
116
19b20927172d Uploaded
swebb
parents:
diff changeset
117