annotate pyCRAC/pyBarcodeFilter.xml @ 0:19b20927172d draft

Uploaded
author swebb
date Tue, 18 Jun 2013 09:11:00 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
19b20927172d Uploaded
swebb
parents:
diff changeset
1 <tool id ="pyBarcodeFilter" name="pyBarcodeFilter" force_history_refresh="True">
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 /usr/local/bin/pyBarcodeFilter.pl
19b20927172d Uploaded
swebb
parents:
diff changeset
7 --file_type $ftype.type
19b20927172d Uploaded
swebb
parents:
diff changeset
8 -f $ftype.f
19b20927172d Uploaded
swebb
parents:
diff changeset
9 -b $barcode
19b20927172d Uploaded
swebb
parents:
diff changeset
10 -m $mismatch
19b20927172d Uploaded
swebb
parents:
diff changeset
11 $index
19b20927172d Uploaded
swebb
parents:
diff changeset
12 --out $out
19b20927172d Uploaded
swebb
parents:
diff changeset
13 --id $out.id
19b20927172d Uploaded
swebb
parents:
diff changeset
14 --output_path $__new_file_path__
19b20927172d Uploaded
swebb
parents:
diff changeset
15 #if $ftype.reverse.rev == "yes":
19b20927172d Uploaded
swebb
parents:
diff changeset
16 -r=$ftype.reverse.r
19b20927172d Uploaded
swebb
parents:
diff changeset
17 $ftype.reverse.both
19b20927172d Uploaded
swebb
parents:
diff changeset
18 #end if#
19b20927172d Uploaded
swebb
parents:
diff changeset
19 </command>
19b20927172d Uploaded
swebb
parents:
diff changeset
20 <version_command>pyBarcodeFilter.py --version</version_command>
19b20927172d Uploaded
swebb
parents:
diff changeset
21 <inputs>
19b20927172d Uploaded
swebb
parents:
diff changeset
22 <conditional name="ftype">
19b20927172d Uploaded
swebb
parents:
diff changeset
23 <param name="type" type="select" label="File type">
19b20927172d Uploaded
swebb
parents:
diff changeset
24 <option value="fastq" selected="true">FASTQ</option>
19b20927172d Uploaded
swebb
parents:
diff changeset
25 <option value="fasta">FASTA</option>
19b20927172d Uploaded
swebb
parents:
diff changeset
26 </param>
19b20927172d Uploaded
swebb
parents:
diff changeset
27 <when value="fastq">
19b20927172d Uploaded
swebb
parents:
diff changeset
28 <param format="fastq" name="f" type="data" label="FastQ File -f" help="FastQ format" />
19b20927172d Uploaded
swebb
parents:
diff changeset
29 <conditional name="reverse">
19b20927172d Uploaded
swebb
parents:
diff changeset
30 <param name="rev" type="select" label="Add a reverse or paired FastQ file">
19b20927172d Uploaded
swebb
parents:
diff changeset
31 <option value="no" selected="true">NO</option>
19b20927172d Uploaded
swebb
parents:
diff changeset
32 <option value="yes">YES</option>
19b20927172d Uploaded
swebb
parents:
diff changeset
33 </param>
19b20927172d Uploaded
swebb
parents:
diff changeset
34 <when value="yes">
19b20927172d Uploaded
swebb
parents:
diff changeset
35 <param format="fastq" name="r" type="data" label="Reverse FastQ File -f" help="FastQ format" />
19b20927172d Uploaded
swebb
parents:
diff changeset
36 <param name="both" type="select" label="Search for barcode in both reads">
19b20927172d Uploaded
swebb
parents:
diff changeset
37 <option value="" selected="true">NO</option>
19b20927172d Uploaded
swebb
parents:
diff changeset
38 <option value="--both">YES</option>
19b20927172d Uploaded
swebb
parents:
diff changeset
39 </param>
19b20927172d Uploaded
swebb
parents:
diff changeset
40 </when>
19b20927172d Uploaded
swebb
parents:
diff changeset
41 <when value="no">
19b20927172d Uploaded
swebb
parents:
diff changeset
42 </when>
19b20927172d Uploaded
swebb
parents:
diff changeset
43 </conditional>
19b20927172d Uploaded
swebb
parents:
diff changeset
44 </when>
19b20927172d Uploaded
swebb
parents:
diff changeset
45 <when value="fasta">
19b20927172d Uploaded
swebb
parents:
diff changeset
46 <param format="fasta" name="f" type="data" label="FastA File -f" help="FastA format" />
19b20927172d Uploaded
swebb
parents:
diff changeset
47 <conditional name="reverse">
19b20927172d Uploaded
swebb
parents:
diff changeset
48 <param name="rev" type="select" label="Add a reverse or paired FastA file">
19b20927172d Uploaded
swebb
parents:
diff changeset
49 <option value="no" selected="true">NO</option>
19b20927172d Uploaded
swebb
parents:
diff changeset
50 <option value="yes">YES</option>
19b20927172d Uploaded
swebb
parents:
diff changeset
51 </param>
19b20927172d Uploaded
swebb
parents:
diff changeset
52 <when value="yes">
19b20927172d Uploaded
swebb
parents:
diff changeset
53 <param format="fasta" name="r" type="data" label="Reverse FastA File -f" help="FastA format" />
19b20927172d Uploaded
swebb
parents:
diff changeset
54 <param name="both" type="select" label="Search for barcode in both reads">
19b20927172d Uploaded
swebb
parents:
diff changeset
55 <option value="" selected="true">NO</option>
19b20927172d Uploaded
swebb
parents:
diff changeset
56 <option value="--both">YES</option>
19b20927172d Uploaded
swebb
parents:
diff changeset
57 </param>
19b20927172d Uploaded
swebb
parents:
diff changeset
58 </when>
19b20927172d Uploaded
swebb
parents:
diff changeset
59 <when value="no">
19b20927172d Uploaded
swebb
parents:
diff changeset
60 </when>
19b20927172d Uploaded
swebb
parents:
diff changeset
61 </conditional>
19b20927172d Uploaded
swebb
parents:
diff changeset
62 </when>
19b20927172d Uploaded
swebb
parents:
diff changeset
63 </conditional>
19b20927172d Uploaded
swebb
parents:
diff changeset
64 <param format="tabular" name="barcode" type="data" label="Barcode File -f" help="Tab delimited file with barcodes and barcode names" />
19b20927172d Uploaded
swebb
parents:
diff changeset
65 <param format="integer" name="mismatch" type="integer" label="Mismatches -m" value="0" size="3" help="Set the number of allowed mismatches in a barcode">
19b20927172d Uploaded
swebb
parents:
diff changeset
66 <validator type="in_range" min="0" max="100" message="Please enter a value between 0 and 100"/>
19b20927172d Uploaded
swebb
parents:
diff changeset
67 </param>
19b20927172d Uploaded
swebb
parents:
diff changeset
68 <param name="index" type="select" label="Split data using Illumina indexing barcode information -i">
19b20927172d Uploaded
swebb
parents:
diff changeset
69 <option value="" selected="true">NO</option>
19b20927172d Uploaded
swebb
parents:
diff changeset
70 <option value="-i">YES</option>
19b20927172d Uploaded
swebb
parents:
diff changeset
71 </param>
19b20927172d Uploaded
swebb
parents:
diff changeset
72 </inputs>
19b20927172d Uploaded
swebb
parents:
diff changeset
73 <outputs>
19b20927172d Uploaded
swebb
parents:
diff changeset
74 <data format="text" name="out" label="pyBarcodeFilter"/>
19b20927172d Uploaded
swebb
parents:
diff changeset
75 </outputs>
19b20927172d Uploaded
swebb
parents:
diff changeset
76 <help>
19b20927172d Uploaded
swebb
parents:
diff changeset
77
19b20927172d Uploaded
swebb
parents:
diff changeset
78 .. class:: infomark
19b20927172d Uploaded
swebb
parents:
diff changeset
79
19b20927172d Uploaded
swebb
parents:
diff changeset
80 **pySolexaBarcodeFilter**
19b20927172d Uploaded
swebb
parents:
diff changeset
81
19b20927172d Uploaded
swebb
parents:
diff changeset
82 pySolexaBarcodeFilter is part of the pyCRAC_ package. Filters sequence files by barcodes.
19b20927172d Uploaded
swebb
parents:
diff changeset
83
19b20927172d Uploaded
swebb
parents:
diff changeset
84 This tool requires FASTA or FASTQ input files containing the raw data and a text file containing barcode information.
19b20927172d Uploaded
swebb
parents:
diff changeset
85 To process paired end data, use -f and the -r flags to indicate the path to the forward and reverse sequencing reactions, respectively.
19b20927172d Uploaded
swebb
parents:
diff changeset
86 The barcodes file should two columns separated by a tab (see the table below). The first column should contain the barcode nucleotide sequences.
19b20927172d Uploaded
swebb
parents:
diff changeset
87 The second column should contain an identifier, for example, the name of the barcode or the name of the experiment.
19b20927172d Uploaded
swebb
parents:
diff changeset
88 The ā€™Nā€™ in the barcode sequence indicates a random nucleotide. Make sure to use a simple text editor like TextEdit (MacOS X), gedit (Linux/Unix) or use a text editor in the terminal.
19b20927172d Uploaded
swebb
parents:
diff changeset
89 The program is case sensitive: all the nucleotide sequences should be upper case.
19b20927172d Uploaded
swebb
parents:
diff changeset
90 You can freely combine different barcodes but if you are mixing samples containing random nucleotide barcodes and normal barcodes.
19b20927172d Uploaded
swebb
parents:
diff changeset
91 **NOTE!** make sure to place the regular barcode sequence below the sequence with random nucleotides and make sure the shortest sequence is ALWAYS at the bottom in the column (see below)
19b20927172d Uploaded
swebb
parents:
diff changeset
92
19b20927172d Uploaded
swebb
parents:
diff changeset
93 Example of a barcode text file::
19b20927172d Uploaded
swebb
parents:
diff changeset
94
19b20927172d Uploaded
swebb
parents:
diff changeset
95 NNNCGCTTAGC mutant2
19b20927172d Uploaded
swebb
parents:
diff changeset
96 NNNGCGCAGC mutant1
19b20927172d Uploaded
swebb
parents:
diff changeset
97 NNNATTAG control
19b20927172d Uploaded
swebb
parents:
diff changeset
98 NNNTAAGC myfavprotein
19b20927172d Uploaded
swebb
parents:
diff changeset
99 AGC oldcontrol
19b20927172d Uploaded
swebb
parents:
diff changeset
100 AC veryfirstbarcodedsample
19b20927172d Uploaded
swebb
parents:
diff changeset
101
19b20927172d Uploaded
swebb
parents:
diff changeset
102 .. _pyCRAC: http://sandergranneman.bio.ed.ac.uk/Granneman_Lab/pyCRAC_software.html
19b20927172d Uploaded
swebb
parents:
diff changeset
103
19b20927172d Uploaded
swebb
parents:
diff changeset
104 ------
19b20927172d Uploaded
swebb
parents:
diff changeset
105
19b20927172d Uploaded
swebb
parents:
diff changeset
106 **Parameter list**
19b20927172d Uploaded
swebb
parents:
diff changeset
107
19b20927172d Uploaded
swebb
parents:
diff changeset
108 Options::
19b20927172d Uploaded
swebb
parents:
diff changeset
109
19b20927172d Uploaded
swebb
parents:
diff changeset
110 -f FILE, --input_file=FILE
19b20927172d Uploaded
swebb
parents:
diff changeset
111 name of the FASTQ or FASTA input file
19b20927172d Uploaded
swebb
parents:
diff changeset
112 -r FILE, --reverse_input_file=FILE
19b20927172d Uploaded
swebb
parents:
diff changeset
113 name of the paired (or reverse) FASTQ or FASTA input file
19b20927172d Uploaded
swebb
parents:
diff changeset
114 --file_type=FASTQ
19b20927172d Uploaded
swebb
parents:
diff changeset
115 type of file, uncompressed (fasta or fastq) or compressed (fasta.gz or fastq.gz, gzip/gunzip
19b20927172d Uploaded
swebb
parents:
diff changeset
116 compressed). Default is fastq
19b20927172d Uploaded
swebb
parents:
diff changeset
117 -b FILE, --barcode_list=FILE
19b20927172d Uploaded
swebb
parents:
diff changeset
118 name of tab-delimited file containing barcodes and barcode names
19b20927172d Uploaded
swebb
parents:
diff changeset
119 -m 1, --mismatches=1
19b20927172d Uploaded
swebb
parents:
diff changeset
120 to set the number of allowed mismatches in a barcode. A maximum of one mismatch is allowed. Default = 0
19b20927172d Uploaded
swebb
parents:
diff changeset
121 -i, --index
19b20927172d Uploaded
swebb
parents:
diff changeset
122 use this option if you want to split the data using the Illumina indexing barcode information
19b20927172d Uploaded
swebb
parents:
diff changeset
123
19b20927172d Uploaded
swebb
parents:
diff changeset
124 </help>
19b20927172d Uploaded
swebb
parents:
diff changeset
125 </tool>