annotate get_data/kegg_glycan/README_KEGG.md @ 0:89592faa2875 draft

Uploaded
author chrisb
date Wed, 23 Mar 2016 14:35:56 -0400
parents
children 0a5e0df17054
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
89592faa2875 Uploaded
chrisb
parents:
diff changeset
23 ## Help
89592faa2875 Uploaded
chrisb
parents:
diff changeset
24 ```
89592faa2875 Uploaded
chrisb
parents:
diff changeset
25 ../../virtualpy/bin/activate
89592faa2875 Uploaded
chrisb
parents:
diff changeset
26 python findKEGG.py -h
89592faa2875 Uploaded
chrisb
parents:
diff changeset
27 ```
89592faa2875 Uploaded
chrisb
parents:
diff changeset
28
89592faa2875 Uploaded
chrisb
parents:
diff changeset
29 ## Unit Testing?
89592faa2875 Uploaded
chrisb
parents:
diff changeset
30 Yes. Use test_findKEGG.py
89592faa2875 Uploaded
chrisb
parents:
diff changeset
31
89592faa2875 Uploaded
chrisb
parents:
diff changeset
32 ```
89592faa2875 Uploaded
chrisb
parents:
diff changeset
33 ../../virtualpy/bin/activate
89592faa2875 Uploaded
chrisb
parents:
diff changeset
34 python test_findKEGG.py
89592faa2875 Uploaded
chrisb
parents:
diff changeset
35 ```
89592faa2875 Uploaded
chrisb
parents:
diff changeset
36
89592faa2875 Uploaded
chrisb
parents:
diff changeset
37 # 2. getkcfKEGG,py
89592faa2875 Uploaded
chrisb
parents:
diff changeset
38 **get – retrieves given database entries _but only for GLYCANS_**
89592faa2875 Uploaded
chrisb
parents:
diff changeset
39
89592faa2875 Uploaded
chrisb
parents:
diff changeset
40
89592faa2875 Uploaded
chrisb
parents:
diff changeset
41 ## Works with Galaxy?
89592faa2875 Uploaded
chrisb
parents:
diff changeset
42 Yes. see [getkcfKEGG.xml](getkcfKEGG.xml)
89592faa2875 Uploaded
chrisb
parents:
diff changeset
43
89592faa2875 Uploaded
chrisb
parents:
diff changeset
44 ## Command line usage
89592faa2875 Uploaded
chrisb
parents:
diff changeset
45
89592faa2875 Uploaded
chrisb
parents:
diff changeset
46 ```
89592faa2875 Uploaded
chrisb
parents:
diff changeset
47 ../../virtualpy/bin/activate
89592faa2875 Uploaded
chrisb
parents:
diff changeset
48 cat "G00092" > input
89592faa2875 Uploaded
chrisb
parents:
diff changeset
49 python getkcfKEGG.py
89592faa2875 Uploaded
chrisb
parents:
diff changeset
50 ```
89592faa2875 Uploaded
chrisb
parents:
diff changeset
51
89592faa2875 Uploaded
chrisb
parents:
diff changeset
52 This will use the default settings for input, kcfout and dbout
89592faa2875 Uploaded
chrisb
parents:
diff changeset
53 To specify these :
89592faa2875 Uploaded
chrisb
parents:
diff changeset
54 ```
89592faa2875 Uploaded
chrisb
parents:
diff changeset
55 ../../virtualpy/bin/activate
89592faa2875 Uploaded
chrisb
parents:
diff changeset
56 getkcfKEGG.py -i $input -k $kcfout -d $dbout
89592faa2875 Uploaded
chrisb
parents:
diff changeset
57 ```
89592faa2875 Uploaded
chrisb
parents:
diff changeset
58
89592faa2875 Uploaded
chrisb
parents:
diff changeset
59 ## Help
89592faa2875 Uploaded
chrisb
parents:
diff changeset
60 ```
89592faa2875 Uploaded
chrisb
parents:
diff changeset
61 ../../virtualpy/bin/activate
89592faa2875 Uploaded
chrisb
parents:
diff changeset
62 python getkcfKEGG.py -h
89592faa2875 Uploaded
chrisb
parents:
diff changeset
63 ```
89592faa2875 Uploaded
chrisb
parents:
diff changeset
64
89592faa2875 Uploaded
chrisb
parents:
diff changeset
65 ## Unit Testing?
89592faa2875 Uploaded
chrisb
parents:
diff changeset
66 Yes. Use test_getkcfKEGG.py
89592faa2875 Uploaded
chrisb
parents:
diff changeset
67
89592faa2875 Uploaded
chrisb
parents:
diff changeset
68 ```
89592faa2875 Uploaded
chrisb
parents:
diff changeset
69 ../../virtualpy/bin/activate
89592faa2875 Uploaded
chrisb
parents:
diff changeset
70 python test_getkcfKEGG.py
89592faa2875 Uploaded
chrisb
parents:
diff changeset
71 ```
89592faa2875 Uploaded
chrisb
parents:
diff changeset
72
89592faa2875 Uploaded
chrisb
parents:
diff changeset
73 # 3. linkKEGG.py
89592faa2875 Uploaded
chrisb
parents:
diff changeset
74 **link – find related entries by using database cross-references**
89592faa2875 Uploaded
chrisb
parents:
diff changeset
75
89592faa2875 Uploaded
chrisb
parents:
diff changeset
76 ## Works with Galaxy?
89592faa2875 Uploaded
chrisb
parents:
diff changeset
77 Yes. see [linkKEGG.xml](linkKEGG.xml)
89592faa2875 Uploaded
chrisb
parents:
diff changeset
78
89592faa2875 Uploaded
chrisb
parents:
diff changeset
79 ## Command line usage
89592faa2875 Uploaded
chrisb
parents:
diff changeset
80 ```
89592faa2875 Uploaded
chrisb
parents:
diff changeset
81 ../../virtualpy/bin/activate
89592faa2875 Uploaded
chrisb
parents:
diff changeset
82 python linkKEGG.py
89592faa2875 Uploaded
chrisb
parents:
diff changeset
83 ```
89592faa2875 Uploaded
chrisb
parents:
diff changeset
84
89592faa2875 Uploaded
chrisb
parents:
diff changeset
85 This will use the default settings for targetdb, source and output
89592faa2875 Uploaded
chrisb
parents:
diff changeset
86 linkKEGG.py -t $targetdb -s $source -o $output
89592faa2875 Uploaded
chrisb
parents:
diff changeset
87 To specify these :
89592faa2875 Uploaded
chrisb
parents:
diff changeset
88 ```
89592faa2875 Uploaded
chrisb
parents:
diff changeset
89 ../../virtualpy/bin/activate
89592faa2875 Uploaded
chrisb
parents:
diff changeset
90 linkKEGG.py -t $targetdb -s $source -o $output
89592faa2875 Uploaded
chrisb
parents:
diff changeset
91 ```
89592faa2875 Uploaded
chrisb
parents:
diff changeset
92
89592faa2875 Uploaded
chrisb
parents:
diff changeset
93 ## Help
89592faa2875 Uploaded
chrisb
parents:
diff changeset
94 ```
89592faa2875 Uploaded
chrisb
parents:
diff changeset
95 ../../virtualpy/bin/activate
89592faa2875 Uploaded
chrisb
parents:
diff changeset
96 python linkKEGG.py -h
89592faa2875 Uploaded
chrisb
parents:
diff changeset
97 ```
89592faa2875 Uploaded
chrisb
parents:
diff changeset
98
89592faa2875 Uploaded
chrisb
parents:
diff changeset
99 ## Unit Testing?
89592faa2875 Uploaded
chrisb
parents:
diff changeset
100 Yes. Use test_linkKEGG.py
89592faa2875 Uploaded
chrisb
parents:
diff changeset
101
89592faa2875 Uploaded
chrisb
parents:
diff changeset
102 ```
89592faa2875 Uploaded
chrisb
parents:
diff changeset
103 ../../virtualpy/bin/activate
89592faa2875 Uploaded
chrisb
parents:
diff changeset
104 python test_linkKEGG.py
89592faa2875 Uploaded
chrisb
parents:
diff changeset
105 ```
89592faa2875 Uploaded
chrisb
parents:
diff changeset
106