annotate pyCRAC/pyFastqSplitter.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 ="pyFastqSplitter" name="pyFastqSplitter" 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 pyFastqSplitter.pl
19b20927172d Uploaded
swebb
parents:
diff changeset
7 -f $f
19b20927172d Uploaded
swebb
parents:
diff changeset
8 --o1 $out1
19b20927172d Uploaded
swebb
parents:
diff changeset
9 --id $label.value
19b20927172d Uploaded
swebb
parents:
diff changeset
10 --o2 $out2
19b20927172d Uploaded
swebb
parents:
diff changeset
11 --file_type $ftype.type
19b20927172d Uploaded
swebb
parents:
diff changeset
12 #if $joinc.ch == "-c":
19b20927172d Uploaded
swebb
parents:
diff changeset
13 -c $joinc.c
19b20927172d Uploaded
swebb
parents:
diff changeset
14 #end if#
19b20927172d Uploaded
swebb
parents:
diff changeset
15 </command>
19b20927172d Uploaded
swebb
parents:
diff changeset
16 <version_command>/usr/local/bin/pyFastqSplitter.py --version</version_command>
19b20927172d Uploaded
swebb
parents:
diff changeset
17 <inputs>
19b20927172d Uploaded
swebb
parents:
diff changeset
18 <conditional name="ftype">
19b20927172d Uploaded
swebb
parents:
diff changeset
19 <param name="type" type="select" label="File type">
19b20927172d Uploaded
swebb
parents:
diff changeset
20 <option value="fastq" selected="true">FASTQ</option>
19b20927172d Uploaded
swebb
parents:
diff changeset
21 <option value="fasta">FASTA</option>
19b20927172d Uploaded
swebb
parents:
diff changeset
22 </param>
19b20927172d Uploaded
swebb
parents:
diff changeset
23 <when value="fastq">
19b20927172d Uploaded
swebb
parents:
diff changeset
24 <param format="fastq" name="f" type="data" label="FastQ File -f" help="FastQ format" />
19b20927172d Uploaded
swebb
parents:
diff changeset
25 </when>
19b20927172d Uploaded
swebb
parents:
diff changeset
26 <when value="fasta">
19b20927172d Uploaded
swebb
parents:
diff changeset
27 <param format="fasta" name="f" type="data" label="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="Split the reads on the -c character" 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="pyFastqSplitter" 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="out1" label="${label.value}_1.${ftype.type}"/>
19b20927172d Uploaded
swebb
parents:
diff changeset
47 <data format="input" name="out2" label="${label.value}_2.${ftype.type}"/>
19b20927172d Uploaded
swebb
parents:
diff changeset
48 <change_format>
19b20927172d Uploaded
swebb
parents:
diff changeset
49 <when input="ftype.type" value="fasta" format="fasta" />
19b20927172d Uploaded
swebb
parents:
diff changeset
50 </change_format>
19b20927172d Uploaded
swebb
parents:
diff changeset
51 </outputs>
19b20927172d Uploaded
swebb
parents:
diff changeset
52 <help>
19b20927172d Uploaded
swebb
parents:
diff changeset
53
19b20927172d Uploaded
swebb
parents:
diff changeset
54 .. class:: infomark
19b20927172d Uploaded
swebb
parents:
diff changeset
55
19b20927172d Uploaded
swebb
parents:
diff changeset
56 **pyFastqSplitter**
19b20927172d Uploaded
swebb
parents:
diff changeset
57
19b20927172d Uploaded
swebb
parents:
diff changeset
58 pyFastqSplitter is part of the pyCRAC_ package. Splits a merged fastq file (pyFastqJoiner output) in to two files.
19b20927172d Uploaded
swebb
parents:
diff changeset
59
19b20927172d Uploaded
swebb
parents:
diff changeset
60 Example::
19b20927172d Uploaded
swebb
parents:
diff changeset
61
19b20927172d Uploaded
swebb
parents:
diff changeset
62 Here the ":" character was used to separate the two sequences. By using the -c flag you can tell pyFastqSplitter where to split the sequences.
19b20927172d Uploaded
swebb
parents:
diff changeset
63 This character is ignored by pyFastqDuplicateRemover
19b20927172d Uploaded
swebb
parents:
diff changeset
64
19b20927172d Uploaded
swebb
parents:
diff changeset
65
19b20927172d Uploaded
swebb
parents:
diff changeset
66 @FCC102EACXX:3:1101:1343:2181#ATCACGAT/1##CAATAG@FCC102EACXX:3:1101:1343:2181#ATCACGAT/2
19b20927172d Uploaded
swebb
parents:
diff changeset
67 CAAATTAGAGTGTTCAAAGCAGGCGTATTGCTCGAAT:AGCCTTTAAGTTTCAGCCTTGCGACCATACTCCCCCCAGAACCCAAAGA
19b20927172d Uploaded
swebb
parents:
diff changeset
68 +
19b20927172d Uploaded
swebb
parents:
diff changeset
69 `efhYb][bdQQ`eeaeaYbeY^ceU__IXa[^ZYaeYJaSJ`Z`K`YbSb[[daeJRR[YeWd_I^I^ecgc]OV\bdeaegbXb
19b20927172d Uploaded
swebb
parents:
diff changeset
70 @FCC102EACXX:3:1101:1424:2248#ATCACGAT/1##CCAGGA@FCC102EACXX:3:1101:1424:2248#ATCACGAT/2
19b20927172d Uploaded
swebb
parents:
diff changeset
71 CTAACCATAAACTATGCCTACTAGGGATCCAGAGGTG:AAGTCCTTTAAGTTACAGCCTTGCGACCATACTACACCCAGAACCCAAA
19b20927172d Uploaded
swebb
parents:
diff changeset
72 +
19b20927172d Uploaded
swebb
parents:
diff changeset
73 ^_adddhJbaehbedd`dIb_^cXaRI^BBBBBBBBBYJJ\`JQY\`KJ`gY[[QRYY[[`H[_ceI^e[PYO^IWOHW^eaefhh
19b20927172d Uploaded
swebb
parents:
diff changeset
74 @FCC102EACXX:3:1101:1623:2036#ATCACGAN/1##CTCAGC@FCC102EACXX:3:1101:1623:2036#ATCACGAN/2
19b20927172d Uploaded
swebb
parents:
diff changeset
75 CAAAGTTAGGGGATCGAAGATGATCAGATACCGTCGT:GGCCAATCCTTATTGTGTCTGGACCTGGTGAGTTTCCCCGTGTTGAGTC
19b20927172d Uploaded
swebb
parents:
diff changeset
76 +
19b20927172d Uploaded
swebb
parents:
diff changeset
77 bghfc^YbgbeadggfdffeaS^ac_X^cegaGZ_efPP\`ccQ`eY[bQQ[d`ghehaghfgdg[`gb^bd[ePbH^c_c\a_eg
19b20927172d Uploaded
swebb
parents:
diff changeset
78
19b20927172d Uploaded
swebb
parents:
diff changeset
79 Result:
19b20927172d Uploaded
swebb
parents:
diff changeset
80
19b20927172d Uploaded
swebb
parents:
diff changeset
81 Forward reaction:
19b20927172d Uploaded
swebb
parents:
diff changeset
82
19b20927172d Uploaded
swebb
parents:
diff changeset
83 @FCC102EACXX:3:1101:1343:2181#ATCACGAT/1##CAATAG
19b20927172d Uploaded
swebb
parents:
diff changeset
84 CAAATTAGAGTGTTCAAAGCAGGCGTATTGCTCGAAT
19b20927172d Uploaded
swebb
parents:
diff changeset
85 +
19b20927172d Uploaded
swebb
parents:
diff changeset
86 `efhYb][bdQQ`eeaeaYbeY^ceU__IXa[^ZYae
19b20927172d Uploaded
swebb
parents:
diff changeset
87 @FCC102EACXX:3:1101:1424:2248#ATCACGAT/1##CCAGGA
19b20927172d Uploaded
swebb
parents:
diff changeset
88 CTAACCATAAACTATGCCTACTAGGGATCCAGAGGTG
19b20927172d Uploaded
swebb
parents:
diff changeset
89 +
19b20927172d Uploaded
swebb
parents:
diff changeset
90 ^_adddhJbaehbedd`dIb_^cXaRI^BBBBBBBBB
19b20927172d Uploaded
swebb
parents:
diff changeset
91 @FCC102EACXX:3:1101:1623:2036#ATCACGAN/1##CTCAGC
19b20927172d Uploaded
swebb
parents:
diff changeset
92 CAAAGTTAGGGGATCGAAGATGATCAGATACCGTCGT
19b20927172d Uploaded
swebb
parents:
diff changeset
93 +
19b20927172d Uploaded
swebb
parents:
diff changeset
94 bghfc^YbgbeadggfdffeaS^ac_X^cegaGZ_ef
19b20927172d Uploaded
swebb
parents:
diff changeset
95 @FCC102EACXX:3:1101:1574:2214#ATCACGAT/1##CGTTTT
19b20927172d Uploaded
swebb
parents:
diff changeset
96 CTAATGACCCACTCGGCACCTTACGAAATCAAAGTCT
19b20927172d Uploaded
swebb
parents:
diff changeset
97 +
19b20927172d Uploaded
swebb
parents:
diff changeset
98 cdfgYY`cefhhZef\eaggXaceeghfQaeghWNW\
19b20927172d Uploaded
swebb
parents:
diff changeset
99
19b20927172d Uploaded
swebb
parents:
diff changeset
100 Reverse reaction:
19b20927172d Uploaded
swebb
parents:
diff changeset
101
19b20927172d Uploaded
swebb
parents:
diff changeset
102 @FCC102EACXX:3:1101:1343:2181#ATCACGAT/2
19b20927172d Uploaded
swebb
parents:
diff changeset
103 AGCCTTTAAGTTTCAGCCTTGCGACCATACTCCCCCCAGAACCCAAAGA
19b20927172d Uploaded
swebb
parents:
diff changeset
104 +
19b20927172d Uploaded
swebb
parents:
diff changeset
105 YJaSJ`Z`K`YbSb[[daeJRR[YeWd_I^I^ecgc]OV\bdeaegbXb
19b20927172d Uploaded
swebb
parents:
diff changeset
106 @FCC102EACXX:3:1101:1424:2248#ATCACGAT/2
19b20927172d Uploaded
swebb
parents:
diff changeset
107 AAGTCCTTTAAGTTACAGCCTTGCGACCATACTACACCCAGAACCCAAA
19b20927172d Uploaded
swebb
parents:
diff changeset
108 +
19b20927172d Uploaded
swebb
parents:
diff changeset
109 YJJ\`JQY\`KJ`gY[[QRYY[[`H[_ceI^e[PYO^IWOHW^eaefhh
19b20927172d Uploaded
swebb
parents:
diff changeset
110 @FCC102EACXX:3:1101:1623:2036#ATCACGAN/2
19b20927172d Uploaded
swebb
parents:
diff changeset
111 GGCCAATCCTTATTGTGTCTGGACCTGGTGAGTTTCCCCGTGTTGAGTC
19b20927172d Uploaded
swebb
parents:
diff changeset
112 +
19b20927172d Uploaded
swebb
parents:
diff changeset
113 PP\`ccQ`eY[bQQ[d`ghehaghfgdg[`gb^bd[ePbH^c_c\a_eg
19b20927172d Uploaded
swebb
parents:
diff changeset
114
19b20927172d Uploaded
swebb
parents:
diff changeset
115 .. _pyCRAC: http://sandergranneman.bio.ed.ac.uk/Granneman_Lab/pyCRAC_software.html
19b20927172d Uploaded
swebb
parents:
diff changeset
116
19b20927172d Uploaded
swebb
parents:
diff changeset
117 ------
19b20927172d Uploaded
swebb
parents:
diff changeset
118
19b20927172d Uploaded
swebb
parents:
diff changeset
119 **Parameter list**
19b20927172d Uploaded
swebb
parents:
diff changeset
120
19b20927172d Uploaded
swebb
parents:
diff changeset
121 Options::
19b20927172d Uploaded
swebb
parents:
diff changeset
122
19b20927172d Uploaded
swebb
parents:
diff changeset
123 -f fastq_file, --filename=fastq_file
19b20927172d Uploaded
swebb
parents:
diff changeset
124 To provide the names of two raw data files separated
19b20927172d Uploaded
swebb
parents:
diff changeset
125 by a single space. Default = standard input
19b20927172d Uploaded
swebb
parents:
diff changeset
126 --file_type=FASTQ
19b20927172d Uploaded
swebb
parents:
diff changeset
127 Can split joined fasta and fastq files. Fastq is default
19b20927172d Uploaded
swebb
parents:
diff changeset
128 If there isn't a specific character splitting the two reads
19b20927172d Uploaded
swebb
parents:
diff changeset
129 the tool assumes that the two reads were of equal length
19b20927172d Uploaded
swebb
parents:
diff changeset
130 -o splitfastq, --outfile=splitfastq
19b20927172d Uploaded
swebb
parents:
diff changeset
131 Provide the name of the output files (WITHOUT file
19b20927172d Uploaded
swebb
parents:
diff changeset
132 extension). By default the data will be printed to the
19b20927172d Uploaded
swebb
parents:
diff changeset
133 standard output
19b20927172d Uploaded
swebb
parents:
diff changeset
134 -c :, --character=:
19b20927172d Uploaded
swebb
parents:
diff changeset
135 If the joined sequences were separated by a specific
19b20927172d Uploaded
swebb
parents:
diff changeset
136 character then the program can divide the sequences by
19b20927172d Uploaded
swebb
parents:
diff changeset
137 looking for that character
19b20927172d Uploaded
swebb
parents:
diff changeset
138
19b20927172d Uploaded
swebb
parents:
diff changeset
139 </help>
19b20927172d Uploaded
swebb
parents:
diff changeset
140 </tool>