annotate pyCRAC/pyFastqJoiner.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 ="pyFastqJoiner" name="pyFastqJoiner">
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="python">
19b20927172d Uploaded
swebb
parents:
diff changeset
6 /usr/local/bin/pyFastqJoiner.py
19b20927172d Uploaded
swebb
parents:
diff changeset
7 -f $ftype.f1 $ftype.f2
19b20927172d Uploaded
swebb
parents:
diff changeset
8 -o $out
19b20927172d Uploaded
swebb
parents:
diff changeset
9 --file_type=$ftype.type
19b20927172d Uploaded
swebb
parents:
diff changeset
10 #if $joinc.ch == "-c":
19b20927172d Uploaded
swebb
parents:
diff changeset
11 -c $joinc.c
19b20927172d Uploaded
swebb
parents:
diff changeset
12 #end if#
19b20927172d Uploaded
swebb
parents:
diff changeset
13 </command>
19b20927172d Uploaded
swebb
parents:
diff changeset
14 <version_command>/usr/local/bin/pyFastqJoiner.py --version</version_command>
19b20927172d Uploaded
swebb
parents:
diff changeset
15 <inputs>
19b20927172d Uploaded
swebb
parents:
diff changeset
16 <conditional name="ftype">
19b20927172d Uploaded
swebb
parents:
diff changeset
17 <param name="type" type="select" label="File type">
19b20927172d Uploaded
swebb
parents:
diff changeset
18 <option value="fastq" selected="true">FASTQ</option>
19b20927172d Uploaded
swebb
parents:
diff changeset
19 <option value="fasta">FASTA</option>
19b20927172d Uploaded
swebb
parents:
diff changeset
20 </param>
19b20927172d Uploaded
swebb
parents:
diff changeset
21 <when value="fastq">
19b20927172d Uploaded
swebb
parents:
diff changeset
22 <param format="fastq" name="f1" type="data" label="First FastQ File -f" help="FastQ format" />
19b20927172d Uploaded
swebb
parents:
diff changeset
23 <param format="fastq" name="f2" type="data" label="Second FastQ File -f" help="FastQ format" />
19b20927172d Uploaded
swebb
parents:
diff changeset
24 </when>
19b20927172d Uploaded
swebb
parents:
diff changeset
25 <when value="fasta">
19b20927172d Uploaded
swebb
parents:
diff changeset
26 <param format="fasta" name="f1" type="data" label="First FastA File -f" help="FastA format" />
19b20927172d Uploaded
swebb
parents:
diff changeset
27 <param format="fasta" name="f2" type="data" label="Second FastA File -f" help="FastA format" />
19b20927172d Uploaded
swebb
parents:
diff changeset
28 </when>
19b20927172d Uploaded
swebb
parents:
diff changeset
29 </conditional>
19b20927172d Uploaded
swebb
parents:
diff changeset
30 <conditional name="joinc">
19b20927172d Uploaded
swebb
parents:
diff changeset
31 <param name="ch" type="select" label="Insert a character at join">
19b20927172d Uploaded
swebb
parents:
diff changeset
32 <option value="" selected="true">NO</option>
19b20927172d Uploaded
swebb
parents:
diff changeset
33 <option value="-c">YES</option>
19b20927172d Uploaded
swebb
parents:
diff changeset
34 </param>
19b20927172d Uploaded
swebb
parents:
diff changeset
35 <when value="-c">
19b20927172d Uploaded
swebb
parents:
diff changeset
36 <param type="text" name="c" label="Add this character -c" value=":" >
19b20927172d Uploaded
swebb
parents:
diff changeset
37 <validator type="empty_field" message="enter a character or turn this option off" />
19b20927172d Uploaded
swebb
parents:
diff changeset
38 </param>
19b20927172d Uploaded
swebb
parents:
diff changeset
39 </when>
19b20927172d Uploaded
swebb
parents:
diff changeset
40 <when value="">
19b20927172d Uploaded
swebb
parents:
diff changeset
41 </when>
19b20927172d Uploaded
swebb
parents:
diff changeset
42 </conditional>
19b20927172d Uploaded
swebb
parents:
diff changeset
43 <param name="label" type="text" format="txt" size="30" value="pyFastqJoiner" label="Enter output file label -o" />
19b20927172d Uploaded
swebb
parents:
diff changeset
44 </inputs>
19b20927172d Uploaded
swebb
parents:
diff changeset
45 <outputs>
19b20927172d Uploaded
swebb
parents:
diff changeset
46 <data format="input" name="out" label="${label.value}.${ftype.type}"/>
19b20927172d Uploaded
swebb
parents:
diff changeset
47 <change_format>
19b20927172d Uploaded
swebb
parents:
diff changeset
48 <when input="ftype.type" value="fasta" format="fasta" />
19b20927172d Uploaded
swebb
parents:
diff changeset
49 </change_format>
19b20927172d Uploaded
swebb
parents:
diff changeset
50 </outputs>
19b20927172d Uploaded
swebb
parents:
diff changeset
51 <help>
19b20927172d Uploaded
swebb
parents:
diff changeset
52
19b20927172d Uploaded
swebb
parents:
diff changeset
53 .. class:: infomark
19b20927172d Uploaded
swebb
parents:
diff changeset
54
19b20927172d Uploaded
swebb
parents:
diff changeset
55 **pyFastqJoiner**
19b20927172d Uploaded
swebb
parents:
diff changeset
56
19b20927172d Uploaded
swebb
parents:
diff changeset
57 pyFastqJoiner is part of the pyCRAC_ package. Merges paired sequences from two fastq or fasta formatted files.
19b20927172d Uploaded
swebb
parents:
diff changeset
58
19b20927172d Uploaded
swebb
parents:
diff changeset
59 Example::
19b20927172d Uploaded
swebb
parents:
diff changeset
60
19b20927172d Uploaded
swebb
parents:
diff changeset
61 Forward reaction:
19b20927172d Uploaded
swebb
parents:
diff changeset
62
19b20927172d Uploaded
swebb
parents:
diff changeset
63 @FCC102EACXX:3:1101:1343:2181#ATCACGAT/1##CAATAG
19b20927172d Uploaded
swebb
parents:
diff changeset
64 CAAATTAGAGTGTTCAAAGCAGGCGTATTGCTCGAAT
19b20927172d Uploaded
swebb
parents:
diff changeset
65 +
19b20927172d Uploaded
swebb
parents:
diff changeset
66 `efhYb][bdQQ`eeaeaYbeY^ceU__IXa[^ZYae
19b20927172d Uploaded
swebb
parents:
diff changeset
67 @FCC102EACXX:3:1101:1424:2248#ATCACGAT/1##CCAGGA
19b20927172d Uploaded
swebb
parents:
diff changeset
68 CTAACCATAAACTATGCCTACTAGGGATCCAGAGGTG
19b20927172d Uploaded
swebb
parents:
diff changeset
69 +
19b20927172d Uploaded
swebb
parents:
diff changeset
70 ^_adddhJbaehbedd`dIb_^cXaRI^BBBBBBBBB
19b20927172d Uploaded
swebb
parents:
diff changeset
71 @FCC102EACXX:3:1101:1623:2036#ATCACGAN/1##CTCAGC
19b20927172d Uploaded
swebb
parents:
diff changeset
72 CAAAGTTAGGGGATCGAAGATGATCAGATACCGTCGT
19b20927172d Uploaded
swebb
parents:
diff changeset
73 +
19b20927172d Uploaded
swebb
parents:
diff changeset
74 bghfc^YbgbeadggfdffeaS^ac_X^cegaGZ_ef
19b20927172d Uploaded
swebb
parents:
diff changeset
75 @FCC102EACXX:3:1101:1574:2214#ATCACGAT/1##CGTTTT
19b20927172d Uploaded
swebb
parents:
diff changeset
76 CTAATGACCCACTCGGCACCTTACGAAATCAAAGTCT
19b20927172d Uploaded
swebb
parents:
diff changeset
77 +
19b20927172d Uploaded
swebb
parents:
diff changeset
78 cdfgYY`cefhhZef\eaggXaceeghfQaeghWNW\
19b20927172d Uploaded
swebb
parents:
diff changeset
79
19b20927172d Uploaded
swebb
parents:
diff changeset
80 Reverse reaction:
19b20927172d Uploaded
swebb
parents:
diff changeset
81
19b20927172d Uploaded
swebb
parents:
diff changeset
82 @FCC102EACXX:3:1101:1343:2181#ATCACGAT/2
19b20927172d Uploaded
swebb
parents:
diff changeset
83 AGCCTTTAAGTTTCAGCCTTGCGACCATACTCCCCCCAGAACCCAAAGA
19b20927172d Uploaded
swebb
parents:
diff changeset
84 +
19b20927172d Uploaded
swebb
parents:
diff changeset
85 YJaSJ`Z`K`YbSb[[daeJRR[YeWd_I^I^ecgc]OV\bdeaegbXb
19b20927172d Uploaded
swebb
parents:
diff changeset
86 @FCC102EACXX:3:1101:1424:2248#ATCACGAT/2
19b20927172d Uploaded
swebb
parents:
diff changeset
87 AAGTCCTTTAAGTTACAGCCTTGCGACCATACTACACCCAGAACCCAAA
19b20927172d Uploaded
swebb
parents:
diff changeset
88 +
19b20927172d Uploaded
swebb
parents:
diff changeset
89 YJJ\`JQY\`KJ`gY[[QRYY[[`H[_ceI^e[PYO^IWOHW^eaefhh
19b20927172d Uploaded
swebb
parents:
diff changeset
90 @FCC102EACXX:3:1101:1623:2036#ATCACGAN/2
19b20927172d Uploaded
swebb
parents:
diff changeset
91 GGCCAATCCTTATTGTGTCTGGACCTGGTGAGTTTCCCCGTGTTGAGTC
19b20927172d Uploaded
swebb
parents:
diff changeset
92 +
19b20927172d Uploaded
swebb
parents:
diff changeset
93 PP\`ccQ`eY[bQQ[d`ghehaghfgdg[`gb^bd[ePbH^c_c\a_eg
19b20927172d Uploaded
swebb
parents:
diff changeset
94
19b20927172d Uploaded
swebb
parents:
diff changeset
95 Here the ":" character is used to split the two sequences. This character tells pyFastqSplitter where to split the sequences.
19b20927172d Uploaded
swebb
parents:
diff changeset
96 This character is ignored by pyFastqDuplicateRemover
19b20927172d Uploaded
swebb
parents:
diff changeset
97
19b20927172d Uploaded
swebb
parents:
diff changeset
98 Result:
19b20927172d Uploaded
swebb
parents:
diff changeset
99
19b20927172d Uploaded
swebb
parents:
diff changeset
100 @FCC102EACXX:3:1101:1343:2181#ATCACGAT/1##CAATAG@FCC102EACXX:3:1101:1343:2181#ATCACGAT/2
19b20927172d Uploaded
swebb
parents:
diff changeset
101 CAAATTAGAGTGTTCAAAGCAGGCGTATTGCTCGAAT:AGCCTTTAAGTTTCAGCCTTGCGACCATACTCCCCCCAGAACCCAAAGA
19b20927172d Uploaded
swebb
parents:
diff changeset
102 +
19b20927172d Uploaded
swebb
parents:
diff changeset
103 `efhYb][bdQQ`eeaeaYbeY^ceU__IXa[^ZYaeYJaSJ`Z`K`YbSb[[daeJRR[YeWd_I^I^ecgc]OV\bdeaegbXb
19b20927172d Uploaded
swebb
parents:
diff changeset
104 @FCC102EACXX:3:1101:1424:2248#ATCACGAT/1##CCAGGA@FCC102EACXX:3:1101:1424:2248#ATCACGAT/2
19b20927172d Uploaded
swebb
parents:
diff changeset
105 CTAACCATAAACTATGCCTACTAGGGATCCAGAGGTG:AAGTCCTTTAAGTTACAGCCTTGCGACCATACTACACCCAGAACCCAAA
19b20927172d Uploaded
swebb
parents:
diff changeset
106 +
19b20927172d Uploaded
swebb
parents:
diff changeset
107 ^_adddhJbaehbedd`dIb_^cXaRI^BBBBBBBBBYJJ\`JQY\`KJ`gY[[QRYY[[`H[_ceI^e[PYO^IWOHW^eaefhh
19b20927172d Uploaded
swebb
parents:
diff changeset
108 @FCC102EACXX:3:1101:1623:2036#ATCACGAN/1##CTCAGC@FCC102EACXX:3:1101:1623:2036#ATCACGAN/2
19b20927172d Uploaded
swebb
parents:
diff changeset
109 CAAAGTTAGGGGATCGAAGATGATCAGATACCGTCGT:GGCCAATCCTTATTGTGTCTGGACCTGGTGAGTTTCCCCGTGTTGAGTC
19b20927172d Uploaded
swebb
parents:
diff changeset
110 +
19b20927172d Uploaded
swebb
parents:
diff changeset
111 bghfc^YbgbeadggfdffeaS^ac_X^cegaGZ_efPP\`ccQ`eY[bQQ[d`ghehaghfgdg[`gb^bd[ePbH^c_c\a_eg
19b20927172d Uploaded
swebb
parents:
diff changeset
112
19b20927172d Uploaded
swebb
parents:
diff changeset
113 .. _pyCRAC: http://sandergranneman.bio.ed.ac.uk/Granneman_Lab/pyCRAC_software.html
19b20927172d Uploaded
swebb
parents:
diff changeset
114
19b20927172d Uploaded
swebb
parents:
diff changeset
115 ------
19b20927172d Uploaded
swebb
parents:
diff changeset
116
19b20927172d Uploaded
swebb
parents:
diff changeset
117 **Parameter list**
19b20927172d Uploaded
swebb
parents:
diff changeset
118
19b20927172d Uploaded
swebb
parents:
diff changeset
119 Options::
19b20927172d Uploaded
swebb
parents:
diff changeset
120
19b20927172d Uploaded
swebb
parents:
diff changeset
121 -f fastq_file1 fastq_file2
19b20927172d Uploaded
swebb
parents:
diff changeset
122 Provide the names of two raw data files separated by a single space.
19b20927172d Uploaded
swebb
parents:
diff changeset
123 Make sure the first file is the data file of the forward (/1) sequencing reaction.
19b20927172d Uploaded
swebb
parents:
diff changeset
124
19b20927172d Uploaded
swebb
parents:
diff changeset
125 --file_type=FASTQ
19b20927172d Uploaded
swebb
parents:
diff changeset
126 Can join fasta and fastq files. Fastq is default
19b20927172d Uploaded
swebb
parents:
diff changeset
127
19b20927172d Uploaded
swebb
parents:
diff changeset
128 -o mergedfastq.fastq, --outfile=mergedfastq.fastq
19b20927172d Uploaded
swebb
parents:
diff changeset
129 provide the name of the output file. By default it
19b20927172d Uploaded
swebb
parents:
diff changeset
130 will be printed to the standard output
19b20927172d Uploaded
swebb
parents:
diff changeset
131
19b20927172d Uploaded
swebb
parents:
diff changeset
132 -c :
19b20927172d Uploaded
swebb
parents:
diff changeset
133 This option adds the '|' character between the DNA
19b20927172d Uploaded
swebb
parents:
diff changeset
134 sequences so that it is much easier to split the data
19b20927172d Uploaded
swebb
parents:
diff changeset
135 again later on
19b20927172d Uploaded
swebb
parents:
diff changeset
136
19b20927172d Uploaded
swebb
parents:
diff changeset
137
19b20927172d Uploaded
swebb
parents:
diff changeset
138 </help>
19b20927172d Uploaded
swebb
parents:
diff changeset
139 </tool>