annotate pyCRAC/pySelectMotifsFromGTF.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 ="pySelectMotifsFromGTF" name="pySelectMotifsFromGTF">
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/pySelectMotifsFromGTF.py
19b20927172d Uploaded
swebb
parents:
diff changeset
7 --gtf $input
19b20927172d Uploaded
swebb
parents:
diff changeset
8 -m $motif
19b20927172d Uploaded
swebb
parents:
diff changeset
9 -o $out
19b20927172d Uploaded
swebb
parents:
diff changeset
10 -l $length
19b20927172d Uploaded
swebb
parents:
diff changeset
11 -z $zscore
19b20927172d Uploaded
swebb
parents:
diff changeset
12 </command>
19b20927172d Uploaded
swebb
parents:
diff changeset
13 <version_command>/usr/local/bin/pySelectMotifsFromGTF.py --version</version_command>
19b20927172d Uploaded
swebb
parents:
diff changeset
14 <inputs>
19b20927172d Uploaded
swebb
parents:
diff changeset
15 <param format="gtf" name="input" type="data" label="Input File -f" help="pyMotif gtf output files" />
19b20927172d Uploaded
swebb
parents:
diff changeset
16 <param format="txt" name="motif" type="text" size="200" value="KBCTTG" label="motif string" help="Enter motif (all uppercase) you want to extract from the pyMotif gtf output file">
19b20927172d Uploaded
swebb
parents:
diff changeset
17 <validator type="empty_field" />
19b20927172d Uploaded
swebb
parents:
diff changeset
18 </param>
19b20927172d Uploaded
swebb
parents:
diff changeset
19 <param format="integer" type="integer" value="6" size="5" name="length" label="Length --length" help="Set a Kmer Length. Note that the length has to be at least as long as your k-mer sequence, otherwise the program will not run correctly" />
19b20927172d Uploaded
swebb
parents:
diff changeset
20 <param format="float" type="float" value="0" size="5" name="zscore" label="Z Score --Z_score" help="Set a minimum Kmer Z_score" />
19b20927172d Uploaded
swebb
parents:
diff changeset
21 <param name="label" type="text" format="txt" size="30" value="pySelectMotifsFromGTF" label="Enter output file label -o" />
19b20927172d Uploaded
swebb
parents:
diff changeset
22 </inputs>
19b20927172d Uploaded
swebb
parents:
diff changeset
23
19b20927172d Uploaded
swebb
parents:
diff changeset
24 <outputs>
19b20927172d Uploaded
swebb
parents:
diff changeset
25 <data format="gtf" name="out" label="${label.value}_${motif.value}.gtf"/>
19b20927172d Uploaded
swebb
parents:
diff changeset
26 </outputs>
19b20927172d Uploaded
swebb
parents:
diff changeset
27 <help>
19b20927172d Uploaded
swebb
parents:
diff changeset
28
19b20927172d Uploaded
swebb
parents:
diff changeset
29
19b20927172d Uploaded
swebb
parents:
diff changeset
30 .. class:: infomark
19b20927172d Uploaded
swebb
parents:
diff changeset
31
19b20927172d Uploaded
swebb
parents:
diff changeset
32 **pySelectMotifsFromGTF**
19b20927172d Uploaded
swebb
parents:
diff changeset
33
19b20927172d Uploaded
swebb
parents:
diff changeset
34 pySelectMotifsFromGTF is part of the pyCRAC_ package. Extracts your favourite k-mer sequence from pyMotif GTF output files.
19b20927172d Uploaded
swebb
parents:
diff changeset
35 Note that you can include degenerate nucleotides in your motif string::
19b20927172d Uploaded
swebb
parents:
diff changeset
36
19b20927172d Uploaded
swebb
parents:
diff changeset
37 N = A, G, C or T
19b20927172d Uploaded
swebb
parents:
diff changeset
38 R = A or G = puRine
19b20927172d Uploaded
swebb
parents:
diff changeset
39 Y = C or T = pYrimidine
19b20927172d Uploaded
swebb
parents:
diff changeset
40 M = A or C = aroMatic
19b20927172d Uploaded
swebb
parents:
diff changeset
41 S = G or C
19b20927172d Uploaded
swebb
parents:
diff changeset
42 W = A or T
19b20927172d Uploaded
swebb
parents:
diff changeset
43 K = G or T = Keto
19b20927172d Uploaded
swebb
parents:
diff changeset
44 V = A, C or G = Not T (letter after)
19b20927172d Uploaded
swebb
parents:
diff changeset
45 D = A, G or T = Not C
19b20927172d Uploaded
swebb
parents:
diff changeset
46 H = A, C or T = Not G
19b20927172d Uploaded
swebb
parents:
diff changeset
47 B = C, G or T = Not A
19b20927172d Uploaded
swebb
parents:
diff changeset
48
19b20927172d Uploaded
swebb
parents:
diff changeset
49 So if you enter KBCTTG as search string and length=6, then the program will extract a large number of six-mers from your data.
19b20927172d Uploaded
swebb
parents:
diff changeset
50 If you set length = 8, it will look for this pattern in a stretch of 8 nucleotides.
19b20927172d Uploaded
swebb
parents:
diff changeset
51
19b20927172d Uploaded
swebb
parents:
diff changeset
52 .. _pyCRAC: http://sandergranneman.bio.ed.ac.uk/Granneman_Lab/pyCRAC_software.html
19b20927172d Uploaded
swebb
parents:
diff changeset
53
19b20927172d Uploaded
swebb
parents:
diff changeset
54 ------
19b20927172d Uploaded
swebb
parents:
diff changeset
55
19b20927172d Uploaded
swebb
parents:
diff changeset
56 **Parameter list**
19b20927172d Uploaded
swebb
parents:
diff changeset
57
19b20927172d Uploaded
swebb
parents:
diff changeset
58 Options::
19b20927172d Uploaded
swebb
parents:
diff changeset
59
19b20927172d Uploaded
swebb
parents:
diff changeset
60 --gtf=Yourfavoritegtf.gtf
19b20927172d Uploaded
swebb
parents:
diff changeset
61 type the path to the gtf file that you want to use. By
19b20927172d Uploaded
swebb
parents:
diff changeset
62 default it expects data from the standard input
19b20927172d Uploaded
swebb
parents:
diff changeset
63 -o FILE, --output=FILE
19b20927172d Uploaded
swebb
parents:
diff changeset
64 Optional.Specify the name of the output file. Default
19b20927172d Uploaded
swebb
parents:
diff changeset
65 is standard output. Make sure it has the .gtf
19b20927172d Uploaded
swebb
parents:
diff changeset
66 extension!
19b20927172d Uploaded
swebb
parents:
diff changeset
67 -m KBCTTG, --motif=KBCTTG
19b20927172d Uploaded
swebb
parents:
diff changeset
68 Specify the motif you want extract from the GTF file.
19b20927172d Uploaded
swebb
parents:
diff changeset
69 -z 15.0, --Z_score=15.0
19b20927172d Uploaded
swebb
parents:
diff changeset
70 Set a minimum k-mer Z-score. Default=0
19b20927172d Uploaded
swebb
parents:
diff changeset
71 -l 4, --length=4
19b20927172d Uploaded
swebb
parents:
diff changeset
72 Set a k-mer length. Default is no length filtering
19b20927172d Uploaded
swebb
parents:
diff changeset
73
19b20927172d Uploaded
swebb
parents:
diff changeset
74 </help>
19b20927172d Uploaded
swebb
parents:
diff changeset
75 </tool>