annotate get_data/kegg_glycan/README_KEGG.md @ 1:0a5e0df17054 draft default tip

Uploaded
author chrisb
date Fri, 06 May 2016 08:05:48 -0400
parents 89592faa2875
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
89592faa2875 Uploaded
chrisb
parents:
diff changeset
1
89592faa2875 Uploaded
chrisb
parents:
diff changeset
2 [TOC]
89592faa2875 Uploaded
chrisb
parents:
diff changeset
3
89592faa2875 Uploaded
chrisb
parents:
diff changeset
4 # 1. findKEGG.py
89592faa2875 Uploaded
chrisb
parents:
diff changeset
5 **find entries with matching query keywords or other query data in a given database**
89592faa2875 Uploaded
chrisb
parents:
diff changeset
6
89592faa2875 Uploaded
chrisb
parents:
diff changeset
7 ## Works with Galaxy?
89592faa2875 Uploaded
chrisb
parents:
diff changeset
8 Yes. see [findKEGG.xml](findKEGG.xml)
89592faa2875 Uploaded
chrisb
parents:
diff changeset
9
89592faa2875 Uploaded
chrisb
parents:
diff changeset
10 ## Command line usage
89592faa2875 Uploaded
chrisb
parents:
diff changeset
11 ```
89592faa2875 Uploaded
chrisb
parents:
diff changeset
12 ../../virtualpy/bin/activate
89592faa2875 Uploaded
chrisb
parents:
diff changeset
13 python findKEGG.py
89592faa2875 Uploaded
chrisb
parents:
diff changeset
14 ```
89592faa2875 Uploaded
chrisb
parents:
diff changeset
15
89592faa2875 Uploaded
chrisb
parents:
diff changeset
16 This will use the default settings for dbname, searchpattern and output
89592faa2875 Uploaded
chrisb
parents:
diff changeset
17 To specify these :
89592faa2875 Uploaded
chrisb
parents:
diff changeset
18 ```
89592faa2875 Uploaded
chrisb
parents:
diff changeset
19 ../../virtualpy/bin/activate
89592faa2875 Uploaded
chrisb
parents:
diff changeset
20 findKEGG.py -d $dbname -q $searchpattern -o $output
89592faa2875 Uploaded
chrisb
parents:
diff changeset
21 ```
89592faa2875 Uploaded
chrisb
parents:
diff changeset
22
1
0a5e0df17054 Uploaded
chrisb
parents: 0
diff changeset
23 ## Known Issues
0a5e0df17054 Uploaded
chrisb
parents: 0
diff changeset
24 Yes, the and/or functionality of the KEGG rest API (Release 78.0+/05-05, May 16 ) does not always function as expected. This has been resolved in the code. More details, [KEGGnotes.md ](KEGGnotes.md)
0a5e0df17054 Uploaded
chrisb
parents: 0
diff changeset
25
0
89592faa2875 Uploaded
chrisb
parents:
diff changeset
26 ## Help
89592faa2875 Uploaded
chrisb
parents:
diff changeset
27 ```
89592faa2875 Uploaded
chrisb
parents:
diff changeset
28 ../../virtualpy/bin/activate
89592faa2875 Uploaded
chrisb
parents:
diff changeset
29 python findKEGG.py -h
89592faa2875 Uploaded
chrisb
parents:
diff changeset
30 ```
89592faa2875 Uploaded
chrisb
parents:
diff changeset
31
89592faa2875 Uploaded
chrisb
parents:
diff changeset
32 ## Unit Testing?
89592faa2875 Uploaded
chrisb
parents:
diff changeset
33 Yes. Use test_findKEGG.py
89592faa2875 Uploaded
chrisb
parents:
diff changeset
34
89592faa2875 Uploaded
chrisb
parents:
diff changeset
35 ```
89592faa2875 Uploaded
chrisb
parents:
diff changeset
36 ../../virtualpy/bin/activate
1
0a5e0df17054 Uploaded
chrisb
parents: 0
diff changeset
37 nosetests test_findKEGG.py
0
89592faa2875 Uploaded
chrisb
parents:
diff changeset
38 ```
89592faa2875 Uploaded
chrisb
parents:
diff changeset
39
89592faa2875 Uploaded
chrisb
parents:
diff changeset
40 # 2. getkcfKEGG,py
89592faa2875 Uploaded
chrisb
parents:
diff changeset
41 **get – retrieves given database entries _but only for GLYCANS_**
89592faa2875 Uploaded
chrisb
parents:
diff changeset
42
89592faa2875 Uploaded
chrisb
parents:
diff changeset
43
89592faa2875 Uploaded
chrisb
parents:
diff changeset
44 ## Works with Galaxy?
89592faa2875 Uploaded
chrisb
parents:
diff changeset
45 Yes. see [getkcfKEGG.xml](getkcfKEGG.xml)
89592faa2875 Uploaded
chrisb
parents:
diff changeset
46
89592faa2875 Uploaded
chrisb
parents:
diff changeset
47 ## Command line usage
89592faa2875 Uploaded
chrisb
parents:
diff changeset
48
89592faa2875 Uploaded
chrisb
parents:
diff changeset
49 ```
89592faa2875 Uploaded
chrisb
parents:
diff changeset
50 ../../virtualpy/bin/activate
89592faa2875 Uploaded
chrisb
parents:
diff changeset
51 cat "G00092" > input
89592faa2875 Uploaded
chrisb
parents:
diff changeset
52 python getkcfKEGG.py
89592faa2875 Uploaded
chrisb
parents:
diff changeset
53 ```
89592faa2875 Uploaded
chrisb
parents:
diff changeset
54
89592faa2875 Uploaded
chrisb
parents:
diff changeset
55 This will use the default settings for input, kcfout and dbout
89592faa2875 Uploaded
chrisb
parents:
diff changeset
56 To specify these :
89592faa2875 Uploaded
chrisb
parents:
diff changeset
57 ```
89592faa2875 Uploaded
chrisb
parents:
diff changeset
58 ../../virtualpy/bin/activate
89592faa2875 Uploaded
chrisb
parents:
diff changeset
59 getkcfKEGG.py -i $input -k $kcfout -d $dbout
89592faa2875 Uploaded
chrisb
parents:
diff changeset
60 ```
89592faa2875 Uploaded
chrisb
parents:
diff changeset
61
89592faa2875 Uploaded
chrisb
parents:
diff changeset
62 ## Help
89592faa2875 Uploaded
chrisb
parents:
diff changeset
63 ```
89592faa2875 Uploaded
chrisb
parents:
diff changeset
64 ../../virtualpy/bin/activate
89592faa2875 Uploaded
chrisb
parents:
diff changeset
65 python getkcfKEGG.py -h
89592faa2875 Uploaded
chrisb
parents:
diff changeset
66 ```
89592faa2875 Uploaded
chrisb
parents:
diff changeset
67
89592faa2875 Uploaded
chrisb
parents:
diff changeset
68 ## Unit Testing?
89592faa2875 Uploaded
chrisb
parents:
diff changeset
69 Yes. Use test_getkcfKEGG.py
89592faa2875 Uploaded
chrisb
parents:
diff changeset
70
89592faa2875 Uploaded
chrisb
parents:
diff changeset
71 ```
89592faa2875 Uploaded
chrisb
parents:
diff changeset
72 ../../virtualpy/bin/activate
1
0a5e0df17054 Uploaded
chrisb
parents: 0
diff changeset
73 nosetests test_getkcfKEGG.py
0
89592faa2875 Uploaded
chrisb
parents:
diff changeset
74 ```
89592faa2875 Uploaded
chrisb
parents:
diff changeset
75
89592faa2875 Uploaded
chrisb
parents:
diff changeset
76 # 3. linkKEGG.py
89592faa2875 Uploaded
chrisb
parents:
diff changeset
77 **link – find related entries by using database cross-references**
89592faa2875 Uploaded
chrisb
parents:
diff changeset
78
89592faa2875 Uploaded
chrisb
parents:
diff changeset
79 ## Works with Galaxy?
89592faa2875 Uploaded
chrisb
parents:
diff changeset
80 Yes. see [linkKEGG.xml](linkKEGG.xml)
89592faa2875 Uploaded
chrisb
parents:
diff changeset
81
89592faa2875 Uploaded
chrisb
parents:
diff changeset
82 ## Command line usage
89592faa2875 Uploaded
chrisb
parents:
diff changeset
83 ```
89592faa2875 Uploaded
chrisb
parents:
diff changeset
84 ../../virtualpy/bin/activate
89592faa2875 Uploaded
chrisb
parents:
diff changeset
85 python linkKEGG.py
89592faa2875 Uploaded
chrisb
parents:
diff changeset
86 ```
89592faa2875 Uploaded
chrisb
parents:
diff changeset
87
89592faa2875 Uploaded
chrisb
parents:
diff changeset
88 This will use the default settings for targetdb, source and output
89592faa2875 Uploaded
chrisb
parents:
diff changeset
89 linkKEGG.py -t $targetdb -s $source -o $output
89592faa2875 Uploaded
chrisb
parents:
diff changeset
90 To specify these :
89592faa2875 Uploaded
chrisb
parents:
diff changeset
91 ```
89592faa2875 Uploaded
chrisb
parents:
diff changeset
92 ../../virtualpy/bin/activate
89592faa2875 Uploaded
chrisb
parents:
diff changeset
93 linkKEGG.py -t $targetdb -s $source -o $output
89592faa2875 Uploaded
chrisb
parents:
diff changeset
94 ```
89592faa2875 Uploaded
chrisb
parents:
diff changeset
95
89592faa2875 Uploaded
chrisb
parents:
diff changeset
96 ## Help
89592faa2875 Uploaded
chrisb
parents:
diff changeset
97 ```
89592faa2875 Uploaded
chrisb
parents:
diff changeset
98 ../../virtualpy/bin/activate
89592faa2875 Uploaded
chrisb
parents:
diff changeset
99 python linkKEGG.py -h
89592faa2875 Uploaded
chrisb
parents:
diff changeset
100 ```
89592faa2875 Uploaded
chrisb
parents:
diff changeset
101
89592faa2875 Uploaded
chrisb
parents:
diff changeset
102 ## Unit Testing?
89592faa2875 Uploaded
chrisb
parents:
diff changeset
103 Yes. Use test_linkKEGG.py
89592faa2875 Uploaded
chrisb
parents:
diff changeset
104
89592faa2875 Uploaded
chrisb
parents:
diff changeset
105 ```
89592faa2875 Uploaded
chrisb
parents:
diff changeset
106 ../../virtualpy/bin/activate
1
0a5e0df17054 Uploaded
chrisb
parents: 0
diff changeset
107 nosetests test_linkKEGG.py
0
89592faa2875 Uploaded
chrisb
parents:
diff changeset
108 ```
89592faa2875 Uploaded
chrisb
parents:
diff changeset
109