bio 1.0.0 → 1.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (340) hide show
  1. data/bin/bioruby +14 -122
  2. data/bin/br_biofetch.rb +2 -2
  3. data/bin/br_bioflat.rb +2 -2
  4. data/bin/br_biogetseq.rb +2 -2
  5. data/bin/br_pmfetch.rb +3 -3
  6. data/doc/Changes-0.7.rd +77 -0
  7. data/doc/KEGG_API.rd +523 -232
  8. data/doc/KEGG_API.rd.ja +529 -207
  9. data/doc/Tutorial.rd +48 -11
  10. data/lib/bio.rb +59 -6
  11. data/lib/bio/alignment.rb +713 -103
  12. data/lib/bio/appl/bl2seq/report.rb +2 -18
  13. data/lib/bio/appl/blast.rb +108 -91
  14. data/lib/bio/appl/blast/format0.rb +33 -18
  15. data/lib/bio/appl/blast/format8.rb +6 -20
  16. data/lib/bio/appl/blast/report.rb +293 -429
  17. data/lib/bio/appl/blast/rexml.rb +8 -22
  18. data/lib/bio/appl/blast/wublast.rb +21 -12
  19. data/lib/bio/appl/blast/xmlparser.rb +180 -183
  20. data/lib/bio/appl/blat/report.rb +127 -30
  21. data/lib/bio/appl/clustalw.rb +87 -59
  22. data/lib/bio/appl/clustalw/report.rb +20 -22
  23. data/lib/bio/appl/emboss.rb +113 -20
  24. data/lib/bio/appl/fasta.rb +173 -198
  25. data/lib/bio/appl/fasta/format10.rb +244 -347
  26. data/lib/bio/appl/gcg/msf.rb +212 -0
  27. data/lib/bio/appl/gcg/seq.rb +195 -0
  28. data/lib/bio/appl/genscan/report.rb +5 -23
  29. data/lib/bio/appl/hmmer.rb +8 -45
  30. data/lib/bio/appl/hmmer/report.rb +2 -20
  31. data/lib/bio/appl/iprscan/report.rb +374 -0
  32. data/lib/bio/appl/mafft.rb +87 -50
  33. data/lib/bio/appl/mafft/report.rb +151 -44
  34. data/lib/bio/appl/muscle.rb +52 -0
  35. data/lib/bio/appl/phylip/alignment.rb +129 -0
  36. data/lib/bio/appl/phylip/distance_matrix.rb +96 -0
  37. data/lib/bio/appl/probcons.rb +41 -0
  38. data/lib/bio/appl/psort.rb +89 -96
  39. data/lib/bio/appl/psort/report.rb +6 -22
  40. data/lib/bio/appl/pts1.rb +263 -0
  41. data/lib/bio/appl/sim4.rb +26 -36
  42. data/lib/bio/appl/sim4/report.rb +2 -18
  43. data/lib/bio/appl/sosui/report.rb +5 -20
  44. data/lib/bio/appl/spidey/report.rb +2 -2
  45. data/lib/bio/appl/targetp/report.rb +4 -20
  46. data/lib/bio/appl/tcoffee.rb +55 -0
  47. data/lib/bio/appl/tmhmm/report.rb +4 -20
  48. data/lib/bio/command.rb +235 -64
  49. data/lib/bio/data/aa.rb +21 -26
  50. data/lib/bio/data/codontable.rb +2 -20
  51. data/lib/bio/data/na.rb +19 -4
  52. data/lib/bio/db.rb +27 -12
  53. data/lib/bio/db/aaindex.rb +2 -20
  54. data/lib/bio/db/embl/common.rb +4 -21
  55. data/lib/bio/db/embl/embl.rb +33 -85
  56. data/lib/bio/db/embl/sptr.rb +612 -302
  57. data/lib/bio/db/embl/swissprot.rb +10 -29
  58. data/lib/bio/db/embl/trembl.rb +10 -29
  59. data/lib/bio/db/embl/uniprot.rb +10 -29
  60. data/lib/bio/db/fantom.rb +15 -20
  61. data/lib/bio/db/fasta.rb +3 -3
  62. data/lib/bio/db/genbank/common.rb +37 -46
  63. data/lib/bio/db/genbank/ddbj.rb +6 -18
  64. data/lib/bio/db/genbank/genbank.rb +47 -186
  65. data/lib/bio/db/genbank/genpept.rb +4 -17
  66. data/lib/bio/db/genbank/refseq.rb +4 -17
  67. data/lib/bio/db/gff.rb +103 -35
  68. data/lib/bio/db/go.rb +4 -20
  69. data/lib/bio/db/kegg/brite.rb +26 -36
  70. data/lib/bio/db/kegg/compound.rb +81 -85
  71. data/lib/bio/db/kegg/drug.rb +98 -0
  72. data/lib/bio/db/kegg/enzyme.rb +133 -110
  73. data/lib/bio/db/kegg/expression.rb +2 -20
  74. data/lib/bio/db/kegg/genes.rb +208 -238
  75. data/lib/bio/db/kegg/genome.rb +164 -285
  76. data/lib/bio/db/kegg/glycan.rb +114 -157
  77. data/lib/bio/db/kegg/keggtab.rb +242 -303
  78. data/lib/bio/db/kegg/kgml.rb +117 -160
  79. data/lib/bio/db/kegg/orthology.rb +112 -0
  80. data/lib/bio/db/kegg/reaction.rb +54 -69
  81. data/lib/bio/db/kegg/taxonomy.rb +331 -0
  82. data/lib/bio/db/lasergene.rb +209 -0
  83. data/lib/bio/db/litdb.rb +3 -27
  84. data/lib/bio/db/medline.rb +228 -249
  85. data/lib/bio/db/nbrf.rb +3 -3
  86. data/lib/bio/db/newick.rb +510 -0
  87. data/lib/bio/db/nexus.rb +1854 -0
  88. data/lib/bio/db/pdb.rb +5 -17
  89. data/lib/bio/db/pdb/atom.rb +2 -18
  90. data/lib/bio/db/pdb/chain.rb +2 -18
  91. data/lib/bio/db/pdb/chemicalcomponent.rb +2 -18
  92. data/lib/bio/db/pdb/model.rb +2 -18
  93. data/lib/bio/db/pdb/pdb.rb +73 -34
  94. data/lib/bio/db/pdb/residue.rb +4 -20
  95. data/lib/bio/db/pdb/utils.rb +2 -18
  96. data/lib/bio/db/prosite.rb +403 -422
  97. data/lib/bio/db/rebase.rb +84 -40
  98. data/lib/bio/db/soft.rb +404 -0
  99. data/lib/bio/db/transfac.rb +5 -17
  100. data/lib/bio/feature.rb +106 -52
  101. data/lib/bio/io/das.rb +32 -42
  102. data/lib/bio/io/dbget.rb +2 -20
  103. data/lib/bio/io/ddbjxml.rb +77 -138
  104. data/lib/bio/io/ebisoap.rb +158 -0
  105. data/lib/bio/io/ensembl.rb +229 -0
  106. data/lib/bio/io/fastacmd.rb +89 -82
  107. data/lib/bio/io/fetch.rb +163 -96
  108. data/lib/bio/io/flatfile.rb +170 -73
  109. data/lib/bio/io/flatfile/bdb.rb +3 -16
  110. data/lib/bio/io/flatfile/index.rb +2 -2
  111. data/lib/bio/io/flatfile/indexer.rb +3 -2
  112. data/lib/bio/io/higet.rb +12 -31
  113. data/lib/bio/io/keggapi.rb +210 -269
  114. data/lib/bio/io/ncbisoap.rb +155 -0
  115. data/lib/bio/io/pubmed.rb +169 -147
  116. data/lib/bio/io/registry.rb +4 -20
  117. data/lib/bio/io/soapwsdl.rb +43 -38
  118. data/lib/bio/io/sql.rb +242 -305
  119. data/lib/bio/location.rb +407 -285
  120. data/lib/bio/map.rb +410 -0
  121. data/lib/bio/pathway.rb +558 -695
  122. data/lib/bio/reference.rb +272 -75
  123. data/lib/bio/sequence.rb +255 -13
  124. data/lib/bio/sequence/aa.rb +71 -10
  125. data/lib/bio/sequence/common.rb +187 -33
  126. data/lib/bio/sequence/compat.rb +59 -4
  127. data/lib/bio/sequence/format.rb +54 -7
  128. data/lib/bio/sequence/generic.rb +3 -3
  129. data/lib/bio/sequence/na.rb +328 -26
  130. data/lib/bio/shell.rb +11 -4
  131. data/lib/bio/shell/core.rb +221 -160
  132. data/lib/bio/shell/demo.rb +18 -15
  133. data/lib/bio/shell/interface.rb +14 -12
  134. data/lib/bio/shell/irb.rb +95 -0
  135. data/lib/bio/shell/object.rb +45 -26
  136. data/lib/bio/shell/plugin/blast.rb +42 -0
  137. data/lib/bio/shell/plugin/codon.rb +22 -14
  138. data/lib/bio/shell/plugin/das.rb +58 -0
  139. data/lib/bio/shell/plugin/emboss.rb +2 -2
  140. data/lib/bio/shell/plugin/entry.rb +22 -11
  141. data/lib/bio/shell/plugin/flatfile.rb +2 -2
  142. data/lib/bio/shell/plugin/keggapi.rb +13 -6
  143. data/lib/bio/shell/plugin/midi.rb +4 -4
  144. data/lib/bio/shell/plugin/obda.rb +2 -2
  145. data/lib/bio/shell/plugin/psort.rb +56 -0
  146. data/lib/bio/shell/plugin/seq.rb +35 -8
  147. data/lib/bio/shell/plugin/soap.rb +87 -0
  148. data/lib/bio/shell/rails/vendor/plugins/generators/bioruby/bioruby_generator.rb +29 -0
  149. data/lib/bio/shell/rails/vendor/plugins/generators/bioruby/templates/_classes.rhtml +4 -0
  150. data/lib/bio/shell/rails/vendor/plugins/generators/bioruby/templates/_log.rhtml +27 -0
  151. data/lib/bio/shell/rails/vendor/plugins/generators/bioruby/templates/_methods.rhtml +11 -0
  152. data/lib/bio/shell/rails/vendor/plugins/generators/bioruby/templates/_modules.rhtml +4 -0
  153. data/lib/bio/shell/rails/vendor/plugins/generators/bioruby/templates/_variables.rhtml +7 -0
  154. data/lib/bio/shell/rails/vendor/plugins/generators/bioruby/templates/bioruby-bg.gif +0 -0
  155. data/lib/bio/shell/rails/vendor/plugins/generators/bioruby/templates/bioruby-console.png +0 -0
  156. data/lib/bio/shell/rails/{public/images/icon.png → vendor/plugins/generators/bioruby/templates/bioruby-gem.png} +0 -0
  157. data/lib/bio/shell/rails/vendor/plugins/generators/bioruby/templates/bioruby-link.gif +0 -0
  158. data/lib/bio/shell/rails/vendor/plugins/generators/bioruby/templates/bioruby.css +369 -0
  159. data/lib/bio/shell/rails/vendor/plugins/generators/bioruby/templates/bioruby.rhtml +47 -0
  160. data/lib/bio/shell/rails/vendor/plugins/generators/bioruby/templates/bioruby_controller.rb +144 -0
  161. data/lib/bio/shell/rails/vendor/plugins/generators/bioruby/templates/bioruby_helper.rb +47 -0
  162. data/lib/bio/shell/rails/vendor/plugins/generators/bioruby/templates/commands.rhtml +8 -0
  163. data/lib/bio/shell/rails/vendor/plugins/generators/bioruby/templates/history.rhtml +10 -0
  164. data/lib/bio/shell/rails/vendor/plugins/generators/bioruby/templates/index.rhtml +22 -0
  165. data/lib/bio/shell/script.rb +25 -0
  166. data/lib/bio/shell/setup.rb +109 -0
  167. data/lib/bio/shell/web.rb +70 -58
  168. data/lib/bio/tree.rb +850 -0
  169. data/lib/bio/util/color_scheme.rb +84 -107
  170. data/lib/bio/util/color_scheme/buried.rb +5 -24
  171. data/lib/bio/util/color_scheme/helix.rb +5 -24
  172. data/lib/bio/util/color_scheme/hydropathy.rb +5 -24
  173. data/lib/bio/util/color_scheme/nucleotide.rb +5 -24
  174. data/lib/bio/util/color_scheme/strand.rb +5 -24
  175. data/lib/bio/util/color_scheme/taylor.rb +5 -24
  176. data/lib/bio/util/color_scheme/turn.rb +5 -24
  177. data/lib/bio/util/color_scheme/zappo.rb +5 -24
  178. data/lib/bio/util/contingency_table.rb +70 -43
  179. data/lib/bio/util/restriction_enzyme.rb +228 -0
  180. data/lib/bio/util/restriction_enzyme/analysis.rb +249 -0
  181. data/lib/bio/util/restriction_enzyme/analysis_basic.rb +217 -0
  182. data/lib/bio/util/restriction_enzyme/cut_symbol.rb +107 -0
  183. data/lib/bio/util/restriction_enzyme/double_stranded.rb +321 -0
  184. data/lib/bio/util/restriction_enzyme/double_stranded/aligned_strands.rb +130 -0
  185. data/lib/bio/util/restriction_enzyme/double_stranded/cut_location_pair.rb +103 -0
  186. data/lib/bio/util/restriction_enzyme/double_stranded/cut_location_pair_in_enzyme_notation.rb +38 -0
  187. data/lib/bio/util/restriction_enzyme/double_stranded/cut_locations.rb +76 -0
  188. data/lib/bio/util/restriction_enzyme/double_stranded/cut_locations_in_enzyme_notation.rb +107 -0
  189. data/lib/bio/util/restriction_enzyme/enzymes.yaml +7061 -0
  190. data/lib/bio/util/restriction_enzyme/range/cut_range.rb +24 -0
  191. data/lib/bio/util/restriction_enzyme/range/cut_ranges.rb +47 -0
  192. data/lib/bio/util/restriction_enzyme/range/horizontal_cut_range.rb +67 -0
  193. data/lib/bio/util/restriction_enzyme/range/sequence_range.rb +257 -0
  194. data/lib/bio/util/restriction_enzyme/range/sequence_range/calculated_cuts.rb +242 -0
  195. data/lib/bio/util/restriction_enzyme/range/sequence_range/fragment.rb +51 -0
  196. data/lib/bio/util/restriction_enzyme/range/sequence_range/fragments.rb +41 -0
  197. data/lib/bio/util/restriction_enzyme/range/vertical_cut_range.rb +77 -0
  198. data/lib/bio/util/restriction_enzyme/single_strand.rb +199 -0
  199. data/lib/bio/util/restriction_enzyme/single_strand/cut_locations_in_enzyme_notation.rb +135 -0
  200. data/lib/bio/util/restriction_enzyme/single_strand_complement.rb +23 -0
  201. data/lib/bio/util/restriction_enzyme/string_formatting.rb +111 -0
  202. data/lib/bio/util/sirna.rb +4 -22
  203. data/sample/color_scheme_na.rb +4 -12
  204. data/sample/enzymes.rb +78 -0
  205. data/sample/goslim.rb +5 -13
  206. data/sample/psortplot_html.rb +4 -12
  207. data/test/data/blast/2.2.15.blastp.m7 +876 -0
  208. data/test/data/embl/AB090716.embl.rel89 +63 -0
  209. data/test/data/fasta/example1.txt +75 -0
  210. data/test/data/fasta/example2.txt +21 -0
  211. data/test/data/iprscan/merged.raw +32 -0
  212. data/test/data/iprscan/merged.txt +74 -0
  213. data/test/data/soft/GDS100_partial.soft +92 -0
  214. data/test/data/soft/GSE3457_family_partial.soft +874 -0
  215. data/test/functional/bio/io/test_ensembl.rb +103 -0
  216. data/test/functional/bio/io/test_soapwsdl.rb +5 -17
  217. data/test/unit/bio/appl/bl2seq/test_report.rb +2 -2
  218. data/test/unit/bio/appl/blast/test_report.rb +3 -16
  219. data/test/unit/bio/appl/blast/test_xmlparser.rb +4 -16
  220. data/test/unit/bio/appl/genscan/test_report.rb +3 -16
  221. data/test/unit/bio/appl/hmmer/test_report.rb +3 -16
  222. data/test/unit/bio/appl/iprscan/test_report.rb +338 -0
  223. data/test/unit/bio/appl/mafft/test_report.rb +63 -0
  224. data/test/unit/bio/appl/sosui/test_report.rb +3 -16
  225. data/test/unit/bio/appl/targetp/test_report.rb +3 -16
  226. data/test/unit/bio/appl/test_blast.rb +3 -16
  227. data/test/unit/bio/appl/test_fasta.rb +4 -16
  228. data/test/unit/bio/appl/test_pts1.rb +140 -0
  229. data/test/unit/bio/appl/tmhmm/test_report.rb +3 -16
  230. data/test/unit/bio/data/test_aa.rb +4 -17
  231. data/test/unit/bio/data/test_codontable.rb +3 -16
  232. data/test/unit/bio/data/test_na.rb +3 -3
  233. data/test/unit/bio/db/embl/test_common.rb +3 -16
  234. data/test/unit/bio/db/embl/test_embl.rb +3 -16
  235. data/test/unit/bio/db/embl/test_embl_rel89.rb +219 -0
  236. data/test/unit/bio/db/embl/test_sptr.rb +1548 -41
  237. data/test/unit/bio/db/embl/test_uniprot.rb +3 -16
  238. data/test/unit/bio/db/kegg/test_genes.rb +3 -16
  239. data/test/unit/bio/db/pdb/test_pdb.rb +7 -24
  240. data/test/unit/bio/db/test_aaindex.rb +2 -2
  241. data/test/unit/bio/db/test_fasta.rb +3 -16
  242. data/test/unit/bio/db/test_gff.rb +3 -16
  243. data/test/unit/bio/db/test_lasergene.rb +95 -0
  244. data/test/unit/bio/db/test_newick.rb +56 -0
  245. data/test/unit/bio/db/test_nexus.rb +360 -0
  246. data/test/unit/bio/db/test_prosite.rb +5 -18
  247. data/test/unit/bio/db/test_rebase.rb +11 -25
  248. data/test/unit/bio/db/test_soft.rb +138 -0
  249. data/test/unit/bio/io/test_ddbjxml.rb +5 -17
  250. data/test/unit/bio/io/test_ensembl.rb +109 -0
  251. data/test/unit/bio/io/test_fastacmd.rb +3 -16
  252. data/test/unit/bio/io/test_flatfile.rb +237 -0
  253. data/test/unit/bio/io/test_soapwsdl.rb +4 -17
  254. data/test/unit/bio/sequence/test_aa.rb +3 -3
  255. data/test/unit/bio/sequence/test_common.rb +3 -16
  256. data/test/unit/bio/sequence/test_compat.rb +3 -16
  257. data/test/unit/bio/sequence/test_na.rb +29 -3
  258. data/test/unit/bio/shell/plugin/test_seq.rb +8 -8
  259. data/test/unit/bio/test_alignment.rb +16 -27
  260. data/test/unit/bio/test_command.rb +242 -25
  261. data/test/unit/bio/test_db.rb +3 -16
  262. data/test/unit/bio/test_feature.rb +4 -16
  263. data/test/unit/bio/test_location.rb +4 -16
  264. data/test/unit/bio/test_map.rb +230 -0
  265. data/test/unit/bio/test_pathway.rb +4 -16
  266. data/test/unit/bio/test_reference.rb +2 -2
  267. data/test/unit/bio/test_sequence.rb +7 -19
  268. data/test/unit/bio/test_shell.rb +3 -16
  269. data/test/unit/bio/test_tree.rb +593 -0
  270. data/test/unit/bio/util/restriction_enzyme/analysis/test_calculated_cuts.rb +299 -0
  271. data/test/unit/bio/util/restriction_enzyme/analysis/test_cut_ranges.rb +103 -0
  272. data/test/unit/bio/util/restriction_enzyme/analysis/test_sequence_range.rb +240 -0
  273. data/test/unit/bio/util/restriction_enzyme/double_stranded/test_aligned_strands.rb +100 -0
  274. data/test/unit/bio/util/restriction_enzyme/double_stranded/test_cut_location_pair.rb +75 -0
  275. data/test/unit/bio/util/restriction_enzyme/double_stranded/test_cut_location_pair_in_enzyme_notation.rb +73 -0
  276. data/test/unit/bio/util/restriction_enzyme/double_stranded/test_cut_locations.rb +53 -0
  277. data/test/unit/bio/util/restriction_enzyme/double_stranded/test_cut_locations_in_enzyme_notation.rb +104 -0
  278. data/test/unit/bio/util/restriction_enzyme/single_strand/test_cut_locations_in_enzyme_notation.rb +83 -0
  279. data/test/unit/bio/util/restriction_enzyme/test_analysis.rb +246 -0
  280. data/test/unit/bio/util/restriction_enzyme/test_cut_symbol.rb +44 -0
  281. data/test/unit/bio/util/restriction_enzyme/test_double_stranded.rb +115 -0
  282. data/test/unit/bio/util/restriction_enzyme/test_single_strand.rb +147 -0
  283. data/test/unit/bio/util/restriction_enzyme/test_single_strand_complement.rb +147 -0
  284. data/test/unit/bio/util/restriction_enzyme/test_string_formatting.rb +60 -0
  285. data/test/unit/bio/util/test_color_scheme.rb +6 -18
  286. data/test/unit/bio/util/test_contingency_table.rb +6 -18
  287. data/test/unit/bio/util/test_restriction_enzyme.rb +42 -0
  288. data/test/unit/bio/util/test_sirna.rb +3 -16
  289. metadata +228 -169
  290. data/doc/BioRuby.rd.ja +0 -225
  291. data/doc/Design.rd.ja +0 -341
  292. data/doc/TODO.rd.ja +0 -138
  293. data/lib/bio/appl/fasta/format6.rb +0 -37
  294. data/lib/bio/db/kegg/cell.rb +0 -88
  295. data/lib/bio/db/kegg/ko.rb +0 -178
  296. data/lib/bio/shell/rails/Rakefile +0 -10
  297. data/lib/bio/shell/rails/app/controllers/application.rb +0 -4
  298. data/lib/bio/shell/rails/app/controllers/shell_controller.rb +0 -94
  299. data/lib/bio/shell/rails/app/helpers/application_helper.rb +0 -3
  300. data/lib/bio/shell/rails/app/models/shell_connection.rb +0 -30
  301. data/lib/bio/shell/rails/app/views/layouts/shell.rhtml +0 -37
  302. data/lib/bio/shell/rails/app/views/shell/history.rhtml +0 -5
  303. data/lib/bio/shell/rails/app/views/shell/index.rhtml +0 -2
  304. data/lib/bio/shell/rails/app/views/shell/show.rhtml +0 -13
  305. data/lib/bio/shell/rails/config/boot.rb +0 -19
  306. data/lib/bio/shell/rails/config/database.yml +0 -85
  307. data/lib/bio/shell/rails/config/environment.rb +0 -53
  308. data/lib/bio/shell/rails/config/environments/development.rb +0 -19
  309. data/lib/bio/shell/rails/config/environments/production.rb +0 -19
  310. data/lib/bio/shell/rails/config/environments/test.rb +0 -19
  311. data/lib/bio/shell/rails/config/routes.rb +0 -19
  312. data/lib/bio/shell/rails/doc/README_FOR_APP +0 -2
  313. data/lib/bio/shell/rails/public/404.html +0 -8
  314. data/lib/bio/shell/rails/public/500.html +0 -8
  315. data/lib/bio/shell/rails/public/dispatch.cgi +0 -10
  316. data/lib/bio/shell/rails/public/dispatch.fcgi +0 -24
  317. data/lib/bio/shell/rails/public/dispatch.rb +0 -10
  318. data/lib/bio/shell/rails/public/favicon.ico +0 -0
  319. data/lib/bio/shell/rails/public/images/rails.png +0 -0
  320. data/lib/bio/shell/rails/public/index.html +0 -277
  321. data/lib/bio/shell/rails/public/javascripts/controls.js +0 -750
  322. data/lib/bio/shell/rails/public/javascripts/dragdrop.js +0 -584
  323. data/lib/bio/shell/rails/public/javascripts/effects.js +0 -854
  324. data/lib/bio/shell/rails/public/javascripts/prototype.js +0 -1785
  325. data/lib/bio/shell/rails/public/robots.txt +0 -1
  326. data/lib/bio/shell/rails/public/stylesheets/main.css +0 -187
  327. data/lib/bio/shell/rails/script/about +0 -3
  328. data/lib/bio/shell/rails/script/breakpointer +0 -3
  329. data/lib/bio/shell/rails/script/console +0 -3
  330. data/lib/bio/shell/rails/script/destroy +0 -3
  331. data/lib/bio/shell/rails/script/generate +0 -3
  332. data/lib/bio/shell/rails/script/performance/benchmarker +0 -3
  333. data/lib/bio/shell/rails/script/performance/profiler +0 -3
  334. data/lib/bio/shell/rails/script/plugin +0 -3
  335. data/lib/bio/shell/rails/script/process/reaper +0 -3
  336. data/lib/bio/shell/rails/script/process/spawner +0 -3
  337. data/lib/bio/shell/rails/script/process/spinner +0 -3
  338. data/lib/bio/shell/rails/script/runner +0 -3
  339. data/lib/bio/shell/rails/script/server +0 -42
  340. data/lib/bio/shell/rails/test/test_helper.rb +0 -28
@@ -4,146 +4,38 @@
4
4
  #
5
5
  # Copyright:: Copyright (C) 2005, 2006
6
6
  # Toshiaki Katayama <k@bioruby.org>
7
- # License:: Ruby's
7
+ # License:: The Ruby License
8
8
  #
9
- # $Id: bioruby,v 1.15 2006/02/27 09:41:54 k Exp $
9
+ # $Id: bioruby,v 1.19 2007/04/05 23:35:39 trevor Exp $
10
10
  #
11
11
 
12
12
  begin
13
13
  require 'rubygems'
14
- require_gem 'bio', '~> 0.7'
14
+ require_gem 'bio', '>= 1.1.0'
15
15
  rescue LoadError
16
16
  end
17
-
18
-
19
- ### BioRuby shell setup
20
-
21
17
  require 'bio/shell'
22
18
 
19
+ # required to run commands (getseq, ls etc.)
23
20
  include Bio::Shell
24
21
 
25
- # command line argument (working directory or bioruby shell script file)
26
- script = nil
27
- if arg = ARGV.shift
28
- if File.directory?(arg)
29
- # directory or symlink to directory
30
- Dir.chdir(arg)
31
- elsif File.exists?(arg)
32
- # BioRuby shell script (load script after the previous session is restored)
33
- dir = File.dirname(arg)
34
- script = File.basename(arg)
35
- Dir.chdir(dir)
36
- elsif arg
37
- Dir.mkdir(arg)
38
- Dir.chdir(arg)
39
- end
40
- else
41
- unless File.exists?(Bio::Shell.history)
42
- message = "Are you sure to start new session in this directory? [y/n] "
43
- unless Bio::Shell.ask_yes_or_no(message)
44
- exit
45
- end
46
- end
47
- end
48
-
49
- # loading configuration and plugins
50
- Bio::Shell.setup
51
-
52
-
53
- ### IRB setup
54
-
55
- require 'irb'
56
- begin
57
- require 'irb/completion'
58
- Bio::Shell.cache[:readline] = true
59
- rescue LoadError
60
- Bio::Shell.cache[:readline] = false
61
- end
62
-
63
- IRB.setup(nil)
64
-
65
- # set application name
66
- IRB.conf[:AP_NAME] = 'bioruby'
67
-
68
- # change prompt for bioruby
69
- $_ = Bio::Shell.esc_seq
70
- IRB.conf[:PROMPT][:BIORUBY_COLOR] = {
71
- :PROMPT_I => "bio#{$_[:ruby]}ruby#{$_[:none]}> ",
72
- :PROMPT_S => "bio#{$_[:ruby]}ruby#{$_[:none]}%l ",
73
- :PROMPT_C => "bio#{$_[:ruby]}ruby#{$_[:none]}+ ",
74
- :RETURN => " ==> %s\n"
75
- }
76
- IRB.conf[:PROMPT][:BIORUBY] = {
77
- :PROMPT_I => "bioruby> ",
78
- :PROMPT_S => "bioruby%l ",
79
- :PROMPT_C => "bioruby+ ",
80
- :RETURN => " ==> %s\n"
81
- }
82
- if Bio::Shell.config[:color]
83
- IRB.conf[:PROMPT_MODE] = :BIORUBY_COLOR
84
- else
85
- IRB.conf[:PROMPT_MODE] = :BIORUBY
86
- end
87
- IRB.conf[:ECHO] = Bio::Shell.config[:echo] || false
88
-
89
- # irb/input-method.rb >= v1.5 (not in 1.8.2)
90
- #IRB.conf[:SAVE_HISTORY] = 100000
91
-
92
- # not beautifully works
93
- #IRB.conf[:AUTO_INDENT] = true
94
-
95
-
96
- ### Start IRB
97
-
98
- irb = IRB::Irb.new
99
-
100
- # needed for method completion
101
- IRB.conf[:MAIN_CONTEXT] = irb.context
22
+ # setup command line options, working directory, and irb configurations
23
+ Bio::Shell::Setup.new
102
24
 
103
25
  # loading workspace and command history
104
26
  Bio::Shell.load_session
105
27
 
106
- if script
107
- load script
108
- exit
109
- end
110
-
111
- Bio::Shell.create_save_dir
112
-
113
- $history_file = File.open(Bio::Shell.history, "a")
114
- $history_file.sync = true
115
-
116
- # overwrite gets to store history with time stamp
117
- io = IRB.conf[:MAIN_CONTEXT].io
118
-
119
- io.class.class_eval do
120
- alias_method :irb_original_gets, :gets
121
- end
122
-
123
- def io.gets
124
- line = irb_original_gets
125
- $history_file.puts "#{Time.now}\t#{line}" if line
126
- line
127
- end
128
-
129
28
  # main loop
130
- Signal.trap("SIGINT") do
131
- irb.signal_handle
132
- end
133
-
134
- catch(:IRB_EXIT) do
135
- irb.eval_input
136
- end
137
-
138
- $history_file.close if $history_file
29
+ if Bio::Shell.cache[:rails]
30
+ Bio::Shell.cache[:rails].join
31
+ else
32
+ Signal.trap("SIGINT") do
33
+ Bio::Shell.cache[:irb].signal_handle
34
+ end
139
35
 
140
- # shut down the rails server
141
- if $web_server
142
- $web_server.each do |io|
143
- io.close
36
+ catch(:IRB_EXIT) do
37
+ Bio::Shell.cache[:irb].eval_input
144
38
  end
145
- $web_access_log.close if $web_access_log
146
- $web_error_log.close if $web_error_log
147
39
  end
148
40
 
149
41
  # saving workspace, command history and configuration before exit
@@ -4,9 +4,9 @@
4
4
  #
5
5
  # Copyright:: Copyright (C) 2002
6
6
  # Toshiaki Katayama <k@bioruby.org>
7
- # License:: Ruby's
7
+ # License:: The Ruby License
8
8
  #
9
- # $Id: br_biofetch.rb,v 1.3 2006/02/09 16:29:41 k Exp $
9
+ # $Id: br_biofetch.rb,v 1.4 2007/04/05 23:35:39 trevor Exp $
10
10
  #
11
11
 
12
12
  require 'bio/io/fetch'
@@ -4,9 +4,9 @@
4
4
  #
5
5
  # Copyright:: Copyright (C) 2002
6
6
  # Naohisa Goto <ng@bioruby.org>
7
- # License:: Ruby's
7
+ # License:: The Ruby License
8
8
  #
9
- # $Id: br_bioflat.rb,v 1.16 2006/02/22 07:01:05 ngoto Exp $
9
+ # $Id: br_bioflat.rb,v 1.17 2007/04/05 23:35:39 trevor Exp $
10
10
  #
11
11
 
12
12
  require 'bio'
@@ -4,9 +4,9 @@
4
4
  #
5
5
  # Copyright:: Copyright (C) 2003
6
6
  # Toshiaki Katayama <k@bioruby.org>
7
- # License:: Ruby's
7
+ # License:: The Ruby License
8
8
  #
9
- # $Id: br_biogetseq.rb,v 1.3 2006/02/09 16:29:41 k Exp $
9
+ # $Id: br_biogetseq.rb,v 1.4 2007/04/05 23:35:39 trevor Exp $
10
10
  #
11
11
 
12
12
  require 'bio'
@@ -4,12 +4,12 @@
4
4
  #
5
5
  # Copyright:: Copyright (C) 2004, 2005
6
6
  # Toshiaki Katayama <k@bioruby.org>
7
- # License:: Ruby's
7
+ # License:: The Ruby License
8
8
  #
9
- # $Id: br_pmfetch.rb,v 1.6 2006/02/09 16:29:41 k Exp $
9
+ # $Id: br_pmfetch.rb,v 1.7 2007/04/05 23:35:39 trevor Exp $
10
10
  #
11
11
 
12
- PROG_VER = '$Id: br_pmfetch.rb,v 1.6 2006/02/09 16:29:41 k Exp $'
12
+ PROG_VER = '$Id: br_pmfetch.rb,v 1.7 2007/04/05 23:35:39 trevor Exp $'
13
13
  PROG_NAME = File.basename($0)
14
14
 
15
15
 
@@ -183,6 +183,8 @@ instead of a Hash of a entry ID string.
183
183
 
184
184
  --- Bio::Alignment
185
185
 
186
+ In 0.7.0:
187
+
186
188
  * Old Bio::Alignment class is renamed to Bio::Alignment::OriginalAlignment.
187
189
  Now, new Bio::Alignment is a module. However, you don't mind so much
188
190
  because most of the class methods previously existed are defined
@@ -199,6 +201,11 @@ instead of a Hash of a entry ID string.
199
201
  not defined in IUPAC standard even if all bases are equal.
200
202
  * There are more and more changes to be written...
201
203
 
204
+ In 1.1.0:
205
+
206
+ * Bio::Alignment::ClustalWFormatter is removed and methods in this module
207
+ are renemed and moved to Bio::Alignment::Output.
208
+
202
209
  --- Bio::PDB
203
210
 
204
211
  In 0.7.0:
@@ -239,6 +246,21 @@ In 0.7.1:
239
246
  a nucleic acid sequence.
240
247
  * There are more and more changes to be written...
241
248
 
249
+ In 1.1.0:
250
+
251
+ * In Bio::PDB::ATOM#name, #resName, #iCode, and #charge, whitespaces are
252
+ stripped during initializing.
253
+ * In Bio::PDB::ATOM#segID, whitespaces are right-stripped during initializing.
254
+ * In Bio::PDB::ATOM#element, whitespaces are left-stripped during initializing.
255
+ * Bio::PDB::HETATM#name, #resName, #iCode, #charge, #segID, and #element
256
+ are also subject to the above changes, because Bio::PDB::HETATM inherits
257
+ Bio::PDB::ATOM.
258
+ * Bio::PDB::Residue#[] and Bio::PDB::Heterogen#[] are changed to use the
259
+ name field for selecting atoms, because the element field is not useful
260
+ for selecting atoms and is not used in many pdb files.
261
+ * Bio::PDB#record is changed to return an empty array instead of nil
262
+ for a nonexistent record.
263
+
242
264
  --- Bio::FlatFile
243
265
 
244
266
  In 0.7.2:
@@ -261,6 +283,61 @@ In 0.7.2:
261
283
  * Internal structure is now completely changed. Codes depend on the internal
262
284
  structure (which is not recommended) would not work.
263
285
 
286
+ In 1.1.0:
287
+
288
+ * Bio::FlatFile#entry_start_pos and #entry_ended_pos are enabled
289
+ only when Bio::FlatFile#entry_pos_flag is true.
290
+
291
+ --- Bio::ClustalW, Bio::MAFFT, Bio::Sim4
292
+
293
+ In 1.1.0:
294
+
295
+ * Bio::(ClustalW|MAFFT|Sim4)#option is changed to #options.
296
+ * Bio::ClustalW::errorlog and Bio::(MAFFT|Sim4)#log are removed.
297
+ No replacements/alternatives are available.
298
+
299
+ --- Bio::ClustalW, Bio::MAFFT
300
+
301
+ In 1.1.0:
302
+
303
+ * Bio::(ClustalW|MAFFT)#query_align, #query_string, #query_by_filename
304
+ are changed not to get second (and third, ...) arguments.
305
+ * Bio::(ClustalW|MAFFT)#query, #query_string, #query_by_filename
306
+ are changed not trying to guess whether given data is nucleotide or protein.
307
+ * Return value of Bio::(ClustalW|MAFFT)#query with no arguments is changed.
308
+ If the program exists normally (exit status is 0), returns true.
309
+ Otherwise, returns false.
310
+
311
+ --- Bio::MAFFT
312
+
313
+ In 1.1.0:
314
+
315
+ * Bio::MAFFT#output is changed to return a string of multi-fasta
316
+ formmatted text instead of Array of Bio::FastaFormat objects.
317
+ To get an array of Bio::FastaFormat objects, please use
318
+ report.data instead.
319
+
320
+ --- Bio::MAFFT::Report
321
+
322
+ In 1.1.0:
323
+
324
+ * Bio::MAFFT::Report#initialize is changed to get a string of multi-fasta
325
+ formmatted text instead of Array.
326
+
327
+ --- Bio::BLAST::Default::Report, Bio::BLAST::Default::Report::Hit,
328
+ Bio::BLAST::Default::Report::HSP, Bio::BLAST::WU::Report,
329
+ Bio::BLAST::WU::Report::Hit, Bio::BLAST::WU::Report::HSP
330
+
331
+ In 1.1.0:
332
+
333
+ * Hit#evalue, HSP#evalue, WU::Hit#pvalue, and WU::HSP#pvalue are
334
+ changed to return a Float object instead of a String object.
335
+ * Report#expect, Hit#bit_score, and HSP#bit_score are changed to return
336
+ a Float object or nil instead of a String object or nil.
337
+ * Following methods are changed to return an integer value or nil
338
+ instead of a string or nil: score, percent_identity, percent_positive,
339
+ percent_gaps.
340
+
264
341
  === Deleted files
265
342
 
266
343
  : lib/bio/db/genbank.rb
@@ -1,6 +1,6 @@
1
1
  =begin
2
2
 
3
- $Id: KEGG_API.rd,v 1.2 2006/02/23 04:51:23 k Exp $
3
+ $Id: KEGG_API.rd,v 1.5 2006/12/27 13:40:45 k Exp $
4
4
 
5
5
  Copyright (C) 2003-2006 Toshiaki Katayama <k@bioruby.org>
6
6
 
@@ -80,76 +80,96 @@ page at GenomeNet:
80
80
  * ((<Definition>)), ((<ArrayOfDefinition>))
81
81
  * ((<LinkDBRelation>)), ((<ArrayOfLinkDBRelation>))
82
82
  * ((<PathwayElement>)), ((<ArrayOfPathwayElement>))
83
+ * ((<PathwayElementRelation>)), ((<ArrayOfPathwayElementRelation>))
84
+ * ((<Subtype>)), ((<ArrayOfSubtype>))
85
+ * ((<StructureAlignment>)), ((<ArrayOfStructureAlignment>))
83
86
  * ((<Methods>))
84
87
  * ((<Meta information>))
85
- * ((<list_databases>)),
86
- ((<list_organisms>)),
87
- ((<list_pathways>))
88
+ * ((<list_databases>))
89
+ * ((<list_organisms>))
90
+ * ((<list_pathways>))
88
91
  * ((<DBGET>))
89
- * ((<binfo>)),
90
- ((<bfind>)),
91
- ((<bget>)),
92
- ((<btit>)),
93
- ((<bconv>))
92
+ * ((<binfo>))
93
+ * ((<bfind>))
94
+ * ((<bget>))
95
+ * ((<btit>))
96
+ * ((<bconv>))
94
97
  * ((<LinkDB>))
95
- * ((<get_linkdb_by_entry>))
96
- * ((<get_genes_by_enzyme>)),
97
- ((<get_enzymes_by_gene>))
98
- * ((<get_enzymes_by_compound>)),
99
- ((<get_enzymes_by_glycan>)),
100
- ((<get_enzymes_by_reaction>)),
101
- ((<get_compounds_by_enzyme>)),
102
- ((<get_compounds_by_reaction>)),
103
- ((<get_glycans_by_enzyme>)),
104
- ((<get_glycans_by_reaction>)),
105
- ((<get_reactions_by_enzyme>)),
106
- ((<get_reactions_by_compound>)),
107
- ((<get_reactions_by_glycan>))
98
+ * ((<Database cross references>))
99
+ * ((<get_linkdb_by_entry>))
100
+ * ((<get_linkdb_between_databases>))
101
+ * ((<Relation among genes and enzymes>))
102
+ * ((<get_genes_by_enzyme>))
103
+ * ((<get_enzymes_by_gene>))
104
+ * ((<Relation among enzymes, compounds and reactions>))
105
+ * ((<get_enzymes_by_compound>))
106
+ * ((<get_enzymes_by_glycan>))
107
+ * ((<get_enzymes_by_reaction>))
108
+ * ((<get_compounds_by_enzyme>))
109
+ * ((<get_compounds_by_reaction>))
110
+ * ((<get_glycans_by_enzyme>))
111
+ * ((<get_glycans_by_reaction>))
112
+ * ((<get_reactions_by_enzyme>))
113
+ * ((<get_reactions_by_compound>))
114
+ * ((<get_reactions_by_glycan>))
108
115
  * ((<SSDB>))
109
- * ((<get_best_best_neighbors_by_gene>)),
110
- ((<get_best_neighbors_by_gene>)),
111
- ((<get_reverse_best_neighbors_by_gene>)),
112
- ((<get_paralogs_by_gene>))
113
- # * ((<get_neighbors_by_gene>)),
114
- # ((<get_similarity_between_genes>))
116
+ * ((<get_best_best_neighbors_by_gene>))
117
+ * ((<get_best_neighbors_by_gene>))
118
+ * ((<get_reverse_best_neighbors_by_gene>))
119
+ * ((<get_paralogs_by_gene>))
115
120
  * ((<Motif>))
116
- * ((<get_motifs_by_gene>)),
117
- ((<get_genes_by_motifs>))
118
- * ((<KO, OC, PC>))
119
- * ((<get_ko_by_gene>)),
120
- ((<get_ko_by_ko_class>)),
121
- ((<get_genes_by_ko_class>)),
122
- ((<get_genes_by_ko>)),
123
- ((<get_oc_members_by_gene>)),
124
- ((<get_pc_members_by_gene>))
125
- # ((<get_ko_members>)),
121
+ * ((<get_motifs_by_gene>))
122
+ * ((<get_genes_by_motifs>))
123
+ * ((<KO>))
124
+ * ((<get_ko_by_gene>))
125
+ * ((<get_ko_by_ko_class>))
126
+ * ((<get_genes_by_ko_class>))
127
+ * ((<get_genes_by_ko>))
126
128
  * ((<PATHWAY>))
127
- * ((<mark_pathway_by_objects>)),
128
- ((<color_pathway_by_objects>)),
129
- ((<color_pathway_by_elements>)),
130
- ((<get_html_of_marked_pathway_by_objects>)),
131
- ((<get_html_of_colored_pathway_by_objects>)),
132
- ((<get_html_of_colored_pathway_by_elements>))
133
- * ((<get_elements_by_pathway>)),
134
- ((<get_genes_by_pathway>)),
135
- ((<get_enzymes_by_pathway>)),
136
- ((<get_compounds_by_pathway>)),
137
- ((<get_glycans_by_pathway>)),
138
- ((<get_reactions_by_pathway>)),
139
- ((<get_kos_by_pathway>))
140
- * ((<get_pathways_by_genes>)),
141
- ((<get_pathways_by_enzymes>)),
142
- ((<get_pathways_by_compounds>)),
143
- ((<get_pathways_by_glycans>)),
144
- ((<get_pathways_by_reactions>)),
145
- ((<get_pathways_by_kos>))
146
- * ((<get_linked_pathways>))
129
+ * ((<Coloring pathways>))
130
+ * ((<mark_pathway_by_objects>))
131
+ * ((<color_pathway_by_objects>))
132
+ * ((<color_pathway_by_elements>))
133
+ * ((<get_html_of_marked_pathway_by_objects>))
134
+ * ((<get_html_of_colored_pathway_by_objects>))
135
+ * ((<get_html_of_colored_pathway_by_elements>))
136
+ * ((<Relations of objects on the pathway>))
137
+ * ((<get_element_relations_by_pathway>))
138
+ * ((<Objects on the pathway>))
139
+ * ((<get_elements_by_pathway>))
140
+ * ((<get_genes_by_pathway>))
141
+ * ((<get_enzymes_by_pathway>))
142
+ * ((<get_compounds_by_pathway>))
143
+ * ((<get_glycans_by_pathway>))
144
+ * ((<get_reactions_by_pathway>))
145
+ * ((<get_kos_by_pathway>))
146
+ * ((<Pathways by objects>))
147
+ * ((<get_pathways_by_genes>))
148
+ * ((<get_pathways_by_enzymes>))
149
+ * ((<get_pathways_by_compounds>))
150
+ * ((<get_pathways_by_glycans>))
151
+ * ((<get_pathways_by_reactions>))
152
+ * ((<get_pathways_by_kos>))
153
+ * ((<Relation among pathways>))
154
+ * ((<get_linked_pathways>))
147
155
  * ((<GENES>))
148
156
  * ((<get_genes_by_organism>))
149
157
  * ((<GENOME>))
150
158
  * ((<get_number_of_genes_by_organism>))
151
159
  * ((<LIGAND>))
152
160
  * ((<convert_mol_to_kcf>))
161
+ * ((<search_compounds_by_name>))
162
+ * ((<search_drugs_by_name>))
163
+ * ((<search_glycans_by_name>))
164
+ * ((<search_compounds_by_composition>))
165
+ * ((<search_drugs_by_composition>))
166
+ * ((<search_glycans_by_composition>))
167
+ * ((<search_compounds_by_mass>))
168
+ * ((<search_drugs_by_mass>))
169
+ * ((<search_glycans_by_mass>))
170
+ * ((<search_compounds_by_subcomp>))
171
+ * ((<search_drugs_by_subcomp>))
172
+ * ((<search_glycans_by_kcam>))
153
173
 
154
174
  == Introduction
155
175
 
@@ -165,12 +185,12 @@ are shown. After understanding the first exsample, try other APIs.
165
185
  Firstly, you have to install the SOAP related libraries for the
166
186
  programming language of your choice.
167
187
 
168
-
169
188
  === Quick Start with Perl
170
189
 
171
190
  In the case of Perl, you need to install the following packages:
172
191
 
173
- * ((<SOAP Lite|URL:http://soaplite.com/>))
192
+ * ((<SOAP Lite|URL:http://www.soaplite.com/>)) (tested with 0.60)
193
+ * Note: SOAP Lite > 0.60 is reported to have errors in some methods for now.
174
194
  * ((<MIME-Base64|URL:http://search.cpan.org/author/GAAS/MIME-Base64/>))
175
195
  * ((<LWP|URL:http://search.cpan.org/author/GAAS/libwww-perl/>))
176
196
  * ((<URI|URL:http://search.cpan.org/author/GAAS/URI/>))
@@ -185,10 +205,10 @@ Here's a first example in Perl language.
185
205
 
186
206
  $serv = SOAP::Lite->service($wsdl);
187
207
 
188
- $start = 1;
189
- $max_results = 5;
208
+ $offset = 1;
209
+ $limit = 5;
190
210
 
191
- $top5 = $serv->get_best_neighbors_by_gene('eco:b0002', $start, $max_results);
211
+ $top5 = $serv->get_best_neighbors_by_gene('eco:b0002', $offset, $limit);
192
212
 
193
213
  foreach $hit (@{$top5}) {
194
214
  print "$hit->{genes_id1}\t$hit->{genes_id2}\t$hit->{sw_score}\n";
@@ -250,7 +270,13 @@ and b2388 on a Glycolysis pathway of E. coli (path:eco00010).
250
270
 
251
271
  print $result; # URL of the generated image
252
272
 
253
- ==== Perl FAQ
273
+ === Perl FAQ
274
+
275
+ If you use the KEGG API methods which requires arguments in
276
+ ArrayOfstring datatype, you must need following modifications
277
+ depending on the version of SOAP::Lite.
278
+
279
+ ==== SOAP::Lite version <= 0.60
254
280
 
255
281
  As you see in the above example, you always need to convert a Perl's array
256
282
  into a SOAP object expicitly in SOAP::Lite by
@@ -259,6 +285,61 @@ into a SOAP object expicitly in SOAP::Lite by
259
285
 
260
286
  when you pass an array as the argument for any KEGG API method.
261
287
 
288
+ ==== SOAP::Lite version > 0.60
289
+
290
+ You should use version >= 0.69 as the versions between 0.61-0.68 contain bugs.
291
+
292
+ You need to add following code to your program to pass the array of
293
+ string and/or int data to the SOAP server.
294
+
295
+ sub SOAP::Serializer::as_ArrayOfstring{
296
+ my ($self, $value, $name, $type, $attr) = @_;
297
+ return [$name, {'xsi:type' => 'array', %$attr}, $value];
298
+ }
299
+
300
+ sub SOAP::Serializer::as_ArrayOfint{
301
+ my ($self, $value, $name, $type, $attr) = @_;
302
+ return [$name, {'xsi:type' => 'array', %$attr}, $value];
303
+ }
304
+
305
+ By adding the above, you can write
306
+
307
+ $genes = ["eco:b1002", "eco:b2388"];
308
+
309
+ instead of the following (writing as follows is also permitted).
310
+
311
+ $genes = SOAP::Data->type(array => ["eco:b1002", "eco:b2388"]);
312
+
313
+ ==== Sample program
314
+
315
+ You can test with the following script for the SOAP::Lite v0.69.
316
+ If it works, a URL of the generated image will be returned.
317
+
318
+ #!/usr/bin/env perl
319
+
320
+ use SOAP::Lite +trace => [qw(debug)];
321
+
322
+ print "SOAP::Lite = ", $SOAP::Lite::VERSION, "\n";
323
+
324
+ my $serv = SOAP::Lite -> service("http://soap.genome.jp/KEGG.wsdl");
325
+
326
+ my $genes = ["eco:b1002", "eco:b2388"];
327
+
328
+ my $result = $serv->mark_pathway_by_objects("path:eco00010", $genes);
329
+ print $result, "\n";
330
+
331
+ # sub routines implicitly used in the above code
332
+
333
+ sub SOAP::Serializer::as_ArrayOfstring{
334
+ my ($self, $value, $name, $type, $attr) = @_;
335
+ return [$name, {'xsi:type' => 'array', %$attr}, $value];
336
+ }
337
+
338
+ sub SOAP::Serializer::as_ArrayOfint{
339
+ my ($self, $value, $name, $type, $attr) = @_;
340
+ return [$name, {'xsi:type' => 'array', %$attr}, $value];
341
+ }
342
+
262
343
  === Quick Start with Ruby
263
344
 
264
345
  If you are using Ruby 1.8.1 or later, you are ready to use KEGG API
@@ -284,40 +365,40 @@ first example shown above.
284
365
  require 'soap/wsdlDriver'
285
366
 
286
367
  wsdl = "http://soap.genome.jp/KEGG.wsdl"
287
- serv = SOAP::WSDLDriverFactory.new(wsdl).createDriver
368
+ serv = SOAP::WSDLDriverFactory.new(wsdl).create_rpc_driver
288
369
  serv.generate_explicit_type = true
289
370
  # if uncommented, you can see transactions for debug
290
371
  #serv.wiredump_dev = STDERR
291
372
 
292
- start = 1
293
- max_results = 5
373
+ offset = 1
374
+ limit = 5
294
375
 
295
- top5 = serv.get_best_neighbors_by_gene('eco:b0002', start, max_results)
376
+ top5 = serv.get_best_neighbors_by_gene('eco:b0002', offset, limit)
296
377
  top5.each do |hit|
297
378
  print hit.genes_id1, "\t", hit.genes_id2, "\t", hit.sw_score, "\n"
298
379
  end
299
380
 
300
- You may need to iterate to obtain all the results by increasing start
301
- and/or max_results.
381
+ You may need to iterate to obtain all the results by increasing offset
382
+ and/or limit.
302
383
 
303
384
  #!/usr/bin/env ruby
304
385
 
305
386
  require 'soap/wsdlDriver'
306
387
 
307
388
  wsdl = "http://soap.genome.jp/KEGG.wsdl"
308
- serv = SOAP::WSDLDriverFactory.new(wsdl).create_driver
389
+ serv = SOAP::WSDLDriverFactory.new(wsdl).create_rpc_driver
309
390
  serv.generate_explicit_type = true
310
391
 
311
- start = 1
312
- max_results = 100
392
+ offset = 1
393
+ limit = 100
313
394
 
314
395
  loop do
315
- results = serv.get_best_neighbors_by_gene('eco:b0002', start, max_results)
396
+ results = serv.get_best_neighbors_by_gene('eco:b0002', offset, limit)
316
397
  break unless results
317
398
  results.each do |hit|
318
399
  print hit.genes_id1, "\t", hit.genes_id2, "\t", hit.sw_score, "\n"
319
400
  end
320
- start += max_results
401
+ offset += limit
321
402
  end
322
403
 
323
404
  It is automatically done by using ((<BioRuby|URL:http://bioruby.org/>))
@@ -379,7 +460,6 @@ and equivalent for the last example is as follows.
379
460
 
380
461
  print result # URL of the generated image
381
462
 
382
-
383
463
  === Quick Start with Python
384
464
 
385
465
  In the case of Python, you have to install
@@ -402,7 +482,6 @@ Here's a sample code using KEGG API with Python.
402
482
  results = serv.get_genes_by_pathway('path:eco00020')
403
483
  print results
404
484
 
405
-
406
485
  === Quick Start with Java
407
486
 
408
487
  In the case of Java, you need to obtain Apache Axis library version
@@ -500,7 +579,6 @@ For the other cases, consult the javadoc pages generated by WSDL2Java.
500
579
 
501
580
  * ((<URL:http://www.genome.jp/kegg/soap/doc/keggapi_javadoc/>))
502
581
 
503
-
504
582
  == KEGG API Reference
505
583
 
506
584
  === WSDL file
@@ -524,26 +602,30 @@ the KEGG API can be found at:
524
602
  * 'entry_id' is a unique identifier of which format is the combination of
525
603
  the database name and the identifier of an entry joined by a colon sign
526
604
  as 'database:entry' (e.g. 'embl:J00231' means an EMBL entry 'J00231').
527
- 'entry_id' includes 'genes_id', 'enzyme_id', 'compound_id', 'glycan_id',
528
- 'reaction_id', 'pathway_id' and 'motif_id' described in below.
605
+ 'entry_id' includes 'genes_id', 'enzyme_id', 'compound_id', 'drug_id',
606
+ 'glycan_id', 'reaction_id', 'pathway_id' and 'motif_id' described in below.
529
607
 
530
608
  * 'genes_id' is a gene identifier used in KEGG/GENES which consists of
531
609
  'keggorg' and a gene name (e.g. 'eco:b0001' means an E. coli gene 'b0001').
532
610
 
533
611
  * 'enzyme_id' is an enzyme identifier consisting of database name 'ec'
534
- and an enzyme code used in KEGG/LIGAND (e.g. 'ec:1.1.1.1' means an
535
- alcohol dehydrogenase enzyme)
612
+ and an enzyme code used in KEGG/LIGAND ENZYME database.
613
+ (e.g. 'ec:1.1.1.1' means an alcohol dehydrogenase enzyme)
536
614
 
537
- * 'compound_id' is a compound identifier consisting of database name 'cpd'
538
- and a compound number used in KEGG/LIGAND (e.g. 'cpd:C00158' means a
539
- citric acid). Note that some compounds also have 'glycan_id' and
540
- both IDs are accepted and converted internally by the corresponding
541
- methods.
615
+ * 'compound_id' is a compound identifier consisting of database name
616
+ 'cpd' and a compound number used in KEGG COMPOUND / LIGAND database
617
+ (e.g. 'cpd:C00158' means a citric acid). Note that some compounds
618
+ also have 'glycan_id' and both IDs are accepted and converted internally
619
+ by the corresponding methods.
620
+
621
+ * 'drug_id' is a drug identifier consisting of database name 'dr'
622
+ and a compound number used in KEGG DRUG / LIGAND database
623
+ (e.g. 'dr:D00201' means a tetracycline).
542
624
 
543
625
  * 'glycan_id' is a glycan identifier consisting of database name 'gl'
544
- and a glycan number used in KEGG/GLYCAN (e.g. 'gl:G00050' means a
545
- Paragloboside). Note that some glycans also have 'compound_id' and
546
- both IDs are accepted and converted internally by the corresponding
626
+ and a glycan number used in KEGG GLYCAN database (e.g. 'gl:G00050'
627
+ means a Paragloboside). Note that some glycans also have 'compound_id'
628
+ and both IDs are accepted and converted internally by the corresponding
547
629
  methods.
548
630
 
549
631
  * 'reaction_id' is a reaction identifier consisting of database name 'rn'
@@ -573,9 +655,9 @@ the KEGG API can be found at:
573
655
 
574
656
  * ((<URL:http://www.genome.jp/dbget-bin/get_htext?KO>))
575
657
 
576
- * 'start' and 'max_result' are both an integer and used to control the
658
+ * 'offset' and 'limit' are both an integer and used to control the
577
659
  number of the results returned at once. Methods having these arguments
578
- will return first 'max_result' results starting from 'start'th.
660
+ will return first 'limit' results starting from 'offset'th.
579
661
 
580
662
  * 'fg_color_list' is a list of colors for the foreground (corresponding
581
663
  to the texts and borders of the objects on the KEGG pathway map).
@@ -583,6 +665,9 @@ the KEGG API can be found at:
583
665
  * 'bg_color_list' is a list of colors for the background (corresponding
584
666
  to the inside of the objects on the KEGG pathway map).
585
667
 
668
+ Related site:
669
+ * ((<URL:http://www.genome.jp/kegg/kegg3.html>))
670
+
586
671
  === Returned values
587
672
 
588
673
  Many of the KEGG API methods will return a set of values in a complex data
@@ -614,21 +699,6 @@ SSDBRelation data type contains the following fields:
614
699
  length1 amino acid length of the genes_id1 (int)
615
700
  length2 amino acid length of the genes_id2 (int)
616
701
 
617
- Notice (26 Nov, 2004):
618
-
619
- We found a serious bug with the 'best_flag_1to2' and 'best_flag_2to1'
620
- fields in the SSDBRelation data type. The methods returning the
621
- SSDBRelation (and ArrayOfSSDBRelation) data type had returned the
622
- opposite values of the intended results with the both fields.
623
- The following methods had been affected by this bug:
624
-
625
- # * get_neighbors_by_gene
626
- * get_best_neighbors_by_gene
627
- * get_reverse_best_neighbors_by_gene
628
- * get_paralogs_by_gene
629
- # * get_similarity_between_genes
630
-
631
- This problem is fixed in the KEGG API version 3.2.
632
702
 
633
703
  + ArrayOfSSDBRelation
634
704
 
@@ -679,6 +749,7 @@ ArrayOfLinkDBRelation data type is a list of the LinkDBRelation data type.
679
749
 
680
750
  + PathwayElement
681
751
 
752
+ PathwayElement represents the object on the KEGG PATHWAY map.
682
753
  PathwayElement data type contains the following fields:
683
754
 
684
755
  element_id unique identifier of the object on the pathway (int)
@@ -690,6 +761,50 @@ PathwayElement data type contains the following fields:
690
761
 
691
762
  ArrayOfPathwayElement data type is a list of the PathwayElement data type.
692
763
 
764
+ + PathwayElementRelation
765
+
766
+ PathwayElementRelation represents the relationship between PathwayElements.
767
+ PathwayElementRelation data type contains the following fields:
768
+
769
+ element_id1 unique identifier of the object on the pathway (int)
770
+ element_id2 unique identifier of the object on the pathway (int)
771
+ type type of relation ("ECrel", "maplink" etc.) (string)
772
+ subtypes array of objects involved in the relation (ArrayOfSubtype)
773
+
774
+ + ArrayOfPathwayElementRelation
775
+
776
+ ArrayOfPathwayElementRelation data type is a list of
777
+ the PathwayElementRelation data type.
778
+
779
+ ++ Subtype
780
+
781
+ Subtype is used in the PathwayElementRelation data type to represent
782
+ the object involved in the relation.
783
+ Subtype data type contains the following fields:
784
+
785
+ element_id unique identifier of the object on the pathway (int)
786
+ relation kind of relation ("compound", "inhibition" etc.) (string)
787
+ type type of relation ("+p", "--|" etc.) (string)
788
+
789
+ ++ ArrayOfSubtype
790
+
791
+ ArrayOfSubtype data type is a list of the Subtype data type.
792
+
793
+ + StructureAlignment
794
+
795
+ StructureAlignment represents structural alignment of nodes between
796
+ two molecules with score.
797
+ StructureAlignment data type contains the following fields:
798
+
799
+ target_id entry_id of the target (string)
800
+ score alignment score (float)
801
+ query_nodes indices of aligned nodes in the query molecule (ArrayOfint)
802
+ target_nodes indices of aligned nodes in the target molecule (ArrayOfint)
803
+
804
+ + ArrayOfStructureAlignment
805
+
806
+ ArrayOfStructureAlignment data type is a list of the StructureAlignment
807
+ data type.
693
808
 
694
809
  === Methods
695
810
 
@@ -706,6 +821,10 @@ is returned.
706
821
  Return value:
707
822
  ArrayOfDefinition (db, definition)
708
823
 
824
+ Related site:
825
+ * ((<URL:http://www.genome.jp/dbget/>))
826
+ * ((<URL:http://www.genome.jp/about_genomenet/service.html>)) (section 2.2)
827
+
709
828
  --- list_organisms
710
829
 
711
830
  List up the organisms in the KEGG/GENES database. 'org' code and the
@@ -714,7 +833,11 @@ organism's full name is returned in the Definition data type.
714
833
  Return value:
715
834
  ArrayOfDefinition (org, definition)
716
835
 
717
- --- list_pathways(org)
836
+ Related site:
837
+ * ((<URL:http://www.genome.jp/kegg/catalog/org_list.html>))
838
+ * ((<URL:http://www.genome.jp/dbget-bin/get_htext?Organisms+-n>))
839
+
840
+ --- list_pathways(string:org)
718
841
 
719
842
  List up the pathway maps of the given organism in the KEGG/PATHWAY database.
720
843
  Passing the string "map" as its argument, this method returns a list of the
@@ -723,14 +846,19 @@ reference pathways.
723
846
  Return value:
724
847
  ArrayOfDefinition (pathway_id, definition)
725
848
 
849
+ Related site:
850
+ * ((<URL:http://www.genome.jp/kegg/pathway.html>))
851
+
726
852
  ==== DBGET
727
853
 
728
854
  This section describes the wrapper methods for DBGET system developed
729
855
  at the GenomeNet. For more details on DBGET system, see:
730
856
 
731
- * ((<URL:http://www.genome.jp/dbget/dbget_manual.html>))
857
+ Related site:
858
+ * ((<URL:http://www.genome.jp/dbget/dbget_manual.html>))
859
+ * ((<URL:http://www.genome.jp/dbget-bin/binfo>))
732
860
 
733
- --- binfo(string)
861
+ --- binfo(string:db)
734
862
 
735
863
  Show the version information of the specified database.
736
864
  Passing the string "all" as its argument, this method returns the version
@@ -743,7 +871,7 @@ Example:
743
871
  # Show the information of the latest GenBank database.
744
872
  binfo("gb")
745
873
 
746
- --- bfind(string)
874
+ --- bfind(string:str)
747
875
 
748
876
  Wrapper method for bfind command. bfind is used for searching entries by
749
877
  keywords. User need to specify a database from those which are supported
@@ -758,7 +886,7 @@ Example:
758
886
  # including the word 'E-cadherin' and 'human' from GenBank.
759
887
  bfind("gb E-cadherin human")
760
888
 
761
- --- bget(string)
889
+ --- bget(string:str)
762
890
 
763
891
  The bget command is used for retrieving database entries specified by a list
764
892
  of 'entry_id'. This method accepts all the bget command line options as
@@ -775,7 +903,7 @@ Example:
775
903
  # retrieve amino acid sequence in a FASTA format
776
904
  bget("-f -n a eco:b0002")
777
905
 
778
- --- btit(string)
906
+ --- btit(string:str)
779
907
 
780
908
  Wrapper method for btit command. btit is used for retrieving the definitions
781
909
  by given database entries. Number of entries given at a time is restricted
@@ -789,11 +917,22 @@ Example:
789
917
  # "mmu:13478", "dme:CG5287-PA" and cel:Y60A3A.14".
790
918
  btit("hsa:1798 mmu:13478 dme:CG5287-PA cel:Y60A3A.14")
791
919
 
792
- --- bconv(string)
920
+ --- bconv(string:str)
793
921
 
794
- The bconv command converts external IDs (NCBI GI, NCBI GeneID, GenBank ID,
795
- and UniProt ID) to KEGG IDs. The result is the tab separated pair of the
796
- given ID and the converted ID in each line.
922
+ The bconv command converts external IDs to KEGG IDs.
923
+ Currently, following external databases are available.
924
+
925
+ External database Database prefix
926
+ ----------------- ---------------
927
+ NCBI GI ncbi-gi:
928
+ NCBI GeneID ncbi-geneid:
929
+ GenBank genbank:
930
+ UniGene unigene:
931
+ UniProt uniprot:
932
+ OMIM omim:
933
+
934
+ The result is a tab separated pair of the given ID and the converted ID
935
+ in each line.
797
936
 
798
937
  Return value:
799
938
  string
@@ -802,9 +941,14 @@ Example:
802
941
  # Convert NCBI GI and NCBI GeneID to KEGG genes_id
803
942
  serv.bconv("ncbi-gi:10047086 ncbi-gi:10047090 ncbi-geneid:14751")
804
943
 
944
+ Related site:
945
+ * ((<URL:http://www.genome.jp/kegg/genes.html>)) (Gene name conversion section)
946
+
805
947
  ==== LinkDB
806
948
 
807
- --- get_linkdb_by_entry(entry_id, db, start, max_results)
949
+ + Database cross references
950
+
951
+ --- get_linkdb_by_entry(string:entry_id, string:db, int:offset, int:limit)
808
952
 
809
953
  Retrieve the database entries linked from the user specified database entry.
810
954
  It can also be specified the targeted database.
@@ -817,9 +961,36 @@ Example:
817
961
  get_linkdb_by_entry('eco:b0002', 'pathway', 1, 10)
818
962
  get_linkdb_by_entry('eco:b0002', 'pathway', 11, 10)
819
963
 
964
+ Related site:
965
+ * ((<URL:http://www.genome.jp/dbget-bin/www_linkdb>)) (Single entry to database)
966
+
967
+ --- get_linkdb_between_databases(string:from_db, string:to_db, int:offset, int:limit)
968
+
969
+ Retrieve all links between entries among the given two databases.
970
+
971
+ Return value:
972
+ ArrayOfLinkDBRelation
973
+
974
+ Example:
975
+ # Get all links from "eco" (KEGG GENES) to "pathway" (KEGG PATHWAY)
976
+ # databases.
977
+ get_linkdb_between_databases("eco", "pathway", 1, 100)
978
+
979
+ # Print the contents of obtained links in Ruby language
980
+ links = get_linkdb_between_databases("eco", "pathway", 1, 100)
981
+ links.each do |link|
982
+ puts link.entry_id1 # => "eco:b0084"
983
+ puts link.entry_id2 # => "path:map00550"
984
+ puts link.type # => "indirect"
985
+ puts link.path # => "eco->ec->path"
986
+ end
987
+
988
+ Related site:
989
+ * ((<URL:http://www.genome.jp/dbget-bin/www_linkdb>)) (Database to database)
990
+
820
991
  + Relation among genes and enzymes
821
992
 
822
- --- get_genes_by_enzyme(enzyme_id, org)
993
+ --- get_genes_by_enzyme(string:enzyme_id, string:org)
823
994
 
824
995
  Retrieve all genes of the given organism.
825
996
 
@@ -831,7 +1002,7 @@ Example:
831
1002
  # EC number ec:1.2.1.1
832
1003
  get_genes_by_enzyme('ec:1.2.1.1', 'eco')
833
1004
 
834
- --- get_enzymes_by_gene(genes_id)
1005
+ --- get_enzymes_by_gene(string:genes_id)
835
1006
 
836
1007
  Retrieve all the EC numbers which are assigned to the given gene.
837
1008
 
@@ -845,7 +1016,7 @@ Example:
845
1016
 
846
1017
  + Relation among enzymes, compounds and reactions
847
1018
 
848
- --- get_enzymes_by_compound(compound_id)
1019
+ --- get_enzymes_by_compound(string:compound_id)
849
1020
 
850
1021
  Retrieve all enzymes which have a link to the given compound_id.
851
1022
 
@@ -857,7 +1028,7 @@ Example:
857
1028
  # 'cpd:C00345'
858
1029
  get_enzymes_by_compound('cpd:C00345')
859
1030
 
860
- --- get_enzymes_by_glycan(glycan_id)
1031
+ --- get_enzymes_by_glycan(string:glycan_id)
861
1032
 
862
1033
  Retrieve all enzymes which have a link to the given glycan_id.
863
1034
 
@@ -869,7 +1040,7 @@ Example
869
1040
  # 'gl:G00001'
870
1041
  get_enzymes_by_glycan('gl:G00001')
871
1042
 
872
- --- get_enzymes_by_reaction(reaction_id)
1043
+ --- get_enzymes_by_reaction(string:reaction_id)
873
1044
 
874
1045
  Retrieve all enzymes which have a link to the given reaction_id.
875
1046
 
@@ -881,7 +1052,7 @@ Example:
881
1052
  # 'rn:R00100'.
882
1053
  get_enzymes_by_reaction('rn:R00100')
883
1054
 
884
- --- get_compounds_by_enzyme(enzyme_id)
1055
+ --- get_compounds_by_enzyme(string:enzyme_id)
885
1056
 
886
1057
  Retrieve all compounds which have a link to the given enzyme_id.
887
1058
 
@@ -905,7 +1076,7 @@ Example:
905
1076
  # 'rn:R00100'
906
1077
  get_compounds_by_reaction('rn:R00100')
907
1078
 
908
- --- get_glycans_by_enzyme(enzyme_id)
1079
+ --- get_glycans_by_enzyme(string:enzyme_id)
909
1080
 
910
1081
  Retrieve all glycans which have a link to the given enzyme_id.
911
1082
 
@@ -917,7 +1088,7 @@ Example
917
1088
  # 'ec:2.4.1.141'
918
1089
  get_glycans_by_enzyme('ec:2.4.1.141')
919
1090
 
920
- --- get_glycans_by_reaction(reaction_id)
1091
+ --- get_glycans_by_reaction(string:reaction_id)
921
1092
 
922
1093
  Retrieve all glycans which have a link to the given reaction_id.
923
1094
 
@@ -929,7 +1100,7 @@ Example
929
1100
  # 'rn:R06164'
930
1101
  get_glycans_by_reaction('rn:R06164')
931
1102
 
932
- --- get_reactions_by_enzyme(enzyme_id)
1103
+ --- get_reactions_by_enzyme(string:enzyme_id)
933
1104
 
934
1105
  Retrieve all reactions which have a link to the given enzyme_id.
935
1106
 
@@ -941,7 +1112,7 @@ Example:
941
1112
  # 'ec:2.7.1.12'
942
1113
  get_reactions_by_enzyme('ec:2.7.1.12')
943
1114
 
944
- --- get_reactions_by_compound(compound_id)
1115
+ --- get_reactions_by_compound(string:compound_id)
945
1116
 
946
1117
  Retrieve all reactions which have a link to the given compound_id.
947
1118
 
@@ -953,7 +1124,7 @@ Example:
953
1124
  # 'cpd:C00199'
954
1125
  get_reactions_by_compound('cpd:C00199')
955
1126
 
956
- --- get_reactions_by_glycan(glycan_id)
1127
+ --- get_reactions_by_glycan(string:glycan_id)
957
1128
 
958
1129
  Retrieve all reactions which have a link to the given glycan_id.
959
1130
 
@@ -965,7 +1136,6 @@ Example
965
1136
  # 'gl:G00001'
966
1137
  get_reactions_by_glycan('gl:G00001')
967
1138
 
968
-
969
1139
  ==== SSDB
970
1140
 
971
1141
  This section describes the APIs for SSDB database. For more details
@@ -973,22 +1143,8 @@ on SSDB, see:
973
1143
 
974
1144
  * ((<URL:http://www.genome.jp/kegg/ssdb/>))
975
1145
 
976
- #--- get_neighbors_by_gene(genes_id, org, start, max_results)
977
- #
978
- #Search homologous genes of the user specified 'genes_id' from specified
979
- #organism (or from all organisms if 'all' is given as org).
980
- #
981
- #Return value:
982
- # ArrayOfSSDBRelation
983
- #
984
- #Examples:
985
- # # This will search all homologous genes of E. coli gene 'b0002'
986
- # # in the SSDB and returns the first ten results.
987
- # get_neighbors_by_gene('eco:b0002', 'all', 1, 10)
988
- # # Next ten results.
989
- # get_neighbors_by_gene('eco:b0002', 'all', 11, 10)
990
-
991
- --- get_best_best_neighbors_by_gene(genes_id, start, max_results)
1146
+
1147
+ --- get_best_best_neighbors_by_gene(string:genes_id, int:offset, int:limit)
992
1148
 
993
1149
  Search best-best neighbor of the gene in all organisms.
994
1150
 
@@ -1000,7 +1156,7 @@ Example:
1000
1156
  get_best_best_neighbors_by_gene('eco:b0002', 1, 10)
1001
1157
  get_best_best_neighbors_by_gene('eco:b0002', 11, 10)
1002
1158
 
1003
- --- get_best_neighbors_by_gene(genes_id, start, max_results)
1159
+ --- get_best_neighbors_by_gene(string:genes_id, int:offset, int:limit)
1004
1160
 
1005
1161
  Search best neighbors in all organism.
1006
1162
 
@@ -1012,7 +1168,7 @@ Example:
1012
1168
  get_best_neighbors_by_gene('eco:b0002', 1, 10)
1013
1169
  get_best_neighbors_by_gene('eco:b0002', 11, 10)
1014
1170
 
1015
- --- get_reverse_best_neighbors_by_gene(genes_id, start, max_results)
1171
+ --- get_reverse_best_neighbors_by_gene(string:genes_id, int:offset, int:limit)
1016
1172
 
1017
1173
  Search reverse best neighbors in all organisms.
1018
1174
 
@@ -1024,7 +1180,7 @@ Example:
1024
1180
  get_reverse_best_neighbors_by_gene('eco:b0002', 1, 10)
1025
1181
  get_reverse_best_neighbors_by_gene('eco:b0002', 11, 10)
1026
1182
 
1027
- --- get_paralogs_by_gene(genes_id, start, max_results)
1183
+ --- get_paralogs_by_gene(string:genes_id, int:offset, int:limit)
1028
1184
 
1029
1185
  Search paralogous genes of the given gene in the same organism.
1030
1186
 
@@ -1036,21 +1192,10 @@ Example:
1036
1192
  get_paralogs_by_gene('eco:b0002', 1, 10)
1037
1193
  get_paralogs_by_gene('eco:b0002', 11, 10)
1038
1194
 
1039
- #--- get_similarity_between_genes(genes_id1, genes_id2)
1040
- #
1041
- #Returns data containing Smith-Waterman score and alignment positions
1042
- #between the two genes.
1043
- #
1044
- #Return value:
1045
- # SSDBRelation
1046
- #
1047
- #Example:
1048
- # # Returns a 'sw_score' between two E. coli genes 'b0002' and 'b3940'
1049
- # get_similarity_between_genes('eco:b0002', 'eco:b3940')
1050
1195
 
1051
1196
  ==== Motif
1052
1197
 
1053
- --- get_motifs_by_gene(genes_id, db)
1198
+ --- get_motifs_by_gene(string:genes_id, string:db)
1054
1199
 
1055
1200
  Search motifs in the specified gene. As for 'db',
1056
1201
  user can specify one of the four database; Pfam, TIGRFAM, PROSITE pattern,
@@ -1064,7 +1209,7 @@ Example:
1064
1209
  # Returns the all pfam motifs in the E. coli gene 'b0002'
1065
1210
  get_motifs_by_gene('eco:b0002', 'pfam')
1066
1211
 
1067
- --- get_genes_by_motifs(motif_id_list, start, max_results)
1212
+ --- get_genes_by_motifs([string]:motif_id_list, int:offset, int:limit)
1068
1213
 
1069
1214
  Search all genes which contains all of the specified motifs.
1070
1215
 
@@ -1077,10 +1222,9 @@ Example:
1077
1222
  get_genes_by_motifs(list, 1, 10)
1078
1223
  get_genes_by_motifs(list, 11, 10)
1079
1224
 
1225
+ ==== KO
1080
1226
 
1081
- ==== KO, OC, PC
1082
-
1083
- --- get_ko_by_gene(genes_id)
1227
+ --- get_ko_by_gene(string:genes_id)
1084
1228
 
1085
1229
  Search all KOs to which given genes_id belongs.
1086
1230
 
@@ -1091,18 +1235,8 @@ Example:
1091
1235
  # Returns ko_ids to which GENES entry 'eco:b0002' belongs.
1092
1236
  get_ko_by_gene('eco:b0002')
1093
1237
 
1094
- #--- get_ko_members(ko_id)
1095
- #
1096
- #Returns all genes assigned to the given KO entry.
1097
- #
1098
- #Return value:
1099
- # ArrayOfstring (genes_id)
1100
- #
1101
- #Example
1102
- # # Returns genes_ids those which belong to KO entry 'ko:K02598'.
1103
- # get_ko_members('ko:K02598')
1104
1238
 
1105
- --- get_ko_by_ko_class(ko_class_id)
1239
+ --- get_ko_by_ko_class(string:ko_class_id)
1106
1240
 
1107
1241
  Return all KOs which belong to the given ko_class_id.
1108
1242
 
@@ -1113,7 +1247,7 @@ Example:
1113
1247
  # Returns ko_ids which belong to the KO class '01196'.
1114
1248
  get_ko_by_ko_class('01196')
1115
1249
 
1116
- --- get_genes_by_ko_class(ko_class_id, org, start, max_results)
1250
+ --- get_genes_by_ko_class(string:ko_class_id, string:org, int:offset, int:limit)
1117
1251
 
1118
1252
  Retrieve all genes of the specified organism which are classified
1119
1253
  under the given ko_class_id.
@@ -1125,7 +1259,7 @@ Example:
1125
1259
  # Returns first 100 human genes which belong to the KO class '00930'
1126
1260
  get_genes_by_ko_class('00903', 'hsa' , 1, 100)
1127
1261
 
1128
- --- get_genes_by_ko(ko_id, org)
1262
+ --- get_genes_by_ko(string:ko_id, string:org)
1129
1263
 
1130
1264
  Retrieve all genes of the specified organism which belong to the
1131
1265
  given ko_id.
@@ -1140,31 +1274,6 @@ Example
1140
1274
  # Returns genes of all organisms which are assigned to the KO 'K00010'
1141
1275
  get_genes_by_ko('ko:K00010', 'all')
1142
1276
 
1143
- --- get_oc_members_by_gene(genes_id, start, max_results)
1144
-
1145
- Search all members of the same OC (KEGG Ortholog Cluster) to which given
1146
- genes_id belongs.
1147
-
1148
- Return value:
1149
- ArrayOfstring (genes_id)
1150
-
1151
- Example
1152
- # Returns genes belonging to the same OC with eco:b0002 gene.
1153
- get_oc_members_by_gene('eco:b0002', 1, 10)
1154
- get_oc_members_by_gene('eco:b0002', 11, 10)
1155
-
1156
- --- get_pc_members_by_gene(genes_id, start, max_results)
1157
-
1158
- Search all members of the same PC (KEGG Paralog Cluster) to which given
1159
- genes_id belongs.
1160
-
1161
- Return value:
1162
- ArrayOfstring (genes_id)
1163
-
1164
- Example
1165
- # Returns genes belonging to the same PC with eco:b0002 gene.
1166
- get_pc_members_by_gene('eco:b0002', 1, 10)
1167
- get_pc_members_by_gene('eco:b0002', 11, 10)
1168
1277
 
1169
1278
 
1170
1279
  ==== PATHWAY
@@ -1176,7 +1285,10 @@ on PATHWAY database, see:
1176
1285
 
1177
1286
  + Coloring pathways
1178
1287
 
1179
- --- mark_pathway_by_objects(pathway_id, object_id_list)
1288
+ Related site:
1289
+ * ((<URL:http://www.genome.jp/kegg/tool/color_pathway.html>))
1290
+
1291
+ --- mark_pathway_by_objects(string:pathway_id, [string]:object_id_list)
1180
1292
 
1181
1293
  Mark the given objects on the given pathway map and return the URL of the
1182
1294
  generated image.
@@ -1190,7 +1302,7 @@ Example:
1190
1302
  obj_list = ['eco:b0002', 'cpd:C00263']
1191
1303
  mark_pathway_by_objects('path:eco00260', obj_list)
1192
1304
 
1193
- --- color_pathway_by_objects(pathway_id, object_id_list, fg_color_list, bg_color_list)
1305
+ --- color_pathway_by_objects(string:pathway_id, [string]:object_id_list, [string]:fg_color_list, [string]:bg_color_list)
1194
1306
 
1195
1307
  Color the given objects on the pathway map with the specified colors
1196
1308
  and return the URL of the colored image. In the KEGG pathway maps,
@@ -1212,7 +1324,7 @@ Example:
1212
1324
  bg_list = ['#ffff00', 'yellow']
1213
1325
  color_pathway_by_objects('path:eco00260', obj_list, fg_list, bg_list)
1214
1326
 
1215
- --- color_pathway_by_elements(pathway_id, element_id_list, fg_color_list, bg_color_list)
1327
+ --- color_pathway_by_elements(string:pathway_id, [int]:element_id_list, [string]:fg_color_list, [string]:bg_color_list)
1216
1328
 
1217
1329
  Color the objects (rectangles and circles on a pathway map) corresponding
1218
1330
  to the given 'element_id_list' with the specified colors and return the
@@ -1248,7 +1360,7 @@ Example:
1248
1360
  bg_list = [ '#ffff00', '#ffff00', '#ffcc00', '#ffcc00' ]
1249
1361
  color_pathway_by_elements('path:bsu00010', element_id_list, fg_list, bg_list)
1250
1362
 
1251
- --- get_html_of_marked_pathway_by_objects(pathway_id, object_id_list)
1363
+ --- get_html_of_marked_pathway_by_objects(string:pathway_id, [string]:object_id_list)
1252
1364
 
1253
1365
  HTML version of the 'mark_pathway_by_objects' method.
1254
1366
  Mark the given objects on the given pathway map and return the URL of the
@@ -1265,7 +1377,7 @@ Example:
1265
1377
  obj_list = ['eco:b4258', 'cpd:C00135', 'ko:K01881']
1266
1378
  get_html_of_marked_pathway_by_objects('path:eco00970', obj_list)
1267
1379
 
1268
- --- get_html_of_colored_pathway_by_objects(pathway_id, object_id_list, fg_color_list, bg_color_list)
1380
+ --- get_html_of_colored_pathway_by_objects(string:pathway_id, [string]:object_id_list, [string]:fg_color_list, [string]:bg_color_list)
1269
1381
 
1270
1382
  HTML version of the 'color_pathway_by_object' method.
1271
1383
  Color the given objects on the pathway map with the specified colors
@@ -1285,7 +1397,7 @@ Example:
1285
1397
  bg_list = ['#ff0000', 'yellow', 'orange']
1286
1398
  get_html_of_colored_pathway_by_objects('path:eco00970', obj_list, fg_list, bg_list)
1287
1399
 
1288
- --- get_html_of_colored_pathway_by_elements(pathway_id, element_id_list, fg_color_list, bg_color_list)
1400
+ --- get_html_of_colored_pathway_by_elements(string:pathway_id, [int]:element_id_list, [string]:fg_color_list, [string]:bg_color_list)
1289
1401
 
1290
1402
  HTML version of the 'color_pathway_by_elements' method.
1291
1403
  Color the objects corresponding to the given 'element_id_list' on the pathway
@@ -1307,9 +1419,34 @@ Example:
1307
1419
  bg_list = [ '#ffff00', '#ffff00', '#ffcc00', '#ffcc00' ]
1308
1420
  get_html_of_colored_pathway_by_elements('path:bsu00010', element_id_list, fg_list, bg_list)
1309
1421
 
1422
+ + Relations of objects on the pathway
1423
+
1424
+ --- get_element_relations_by_pathway(string:pathway_id)
1425
+
1426
+ Search all relations of the objects on the specified pathway.
1427
+
1428
+ Return value:
1429
+ ArrayOfPathwayElementRelation
1430
+
1431
+ Example:
1432
+ # Returns list of PathwayElementRelation on the pathway map 'path:bsu00010'
1433
+ relations = get_element_relations_by_pathway('path:bsu00010')
1434
+
1435
+ # Print the contents of obtained relations in Ruby language
1436
+ relations.each do |rel|
1437
+ puts rel.element_id1
1438
+ puts rel.element_id2
1439
+ puts rel.type
1440
+ rel.subtypes.each do |sub|
1441
+ puts sub.element_id
1442
+ puts sub.relation
1443
+ puts sub.type
1444
+ end
1445
+ end
1446
+
1310
1447
  + Objects on the pathway
1311
1448
 
1312
- --- get_elements_by_pathway(pathway_id)
1449
+ --- get_elements_by_pathway(string:pathway_id)
1313
1450
 
1314
1451
  Search all objects on the specified pathway. This method will be used in
1315
1452
  combination with the color_pathway_by_elements method to distingish graphical
@@ -1334,7 +1471,7 @@ Example:
1334
1471
  end
1335
1472
  end
1336
1473
 
1337
- --- get_genes_by_pathway(pathway_id)
1474
+ --- get_genes_by_pathway(string:pathway_id)
1338
1475
 
1339
1476
  Search all genes on the specified pathway. Organism name is given by
1340
1477
  the name of the pathway map.
@@ -1346,7 +1483,7 @@ Example:
1346
1483
  # Returns all E. coli genes on the pathway map '00020'.
1347
1484
  get_genes_by_pathway('path:eco00020')
1348
1485
 
1349
- --- get_enzymes_by_pathway(pathway_id)
1486
+ --- get_enzymes_by_pathway(string:pathway_id)
1350
1487
 
1351
1488
  Search all enzymes on the specified pathway.
1352
1489
 
@@ -1357,7 +1494,7 @@ Example:
1357
1494
  # Returns all E. coli enzymes on the pathway map '00020'.
1358
1495
  get_enzymes_by_pathway('path:eco00020')
1359
1496
 
1360
- --- get_compounds_by_pathway(pathway_id)
1497
+ --- get_compounds_by_pathway(string:pathway_id)
1361
1498
 
1362
1499
  Search all compounds on the specified pathway.
1363
1500
 
@@ -1368,7 +1505,7 @@ Example:
1368
1505
  # Returns all E. coli compounds on the pathway map '00020'.
1369
1506
  get_compounds_by_pathway('path:eco00020')
1370
1507
 
1371
- --- get_glycans_by_pathway(pathway_id)
1508
+ --- get_glycans_by_pathway(string:pathway_id)
1372
1509
 
1373
1510
  Search all glycans on the specified pathway.
1374
1511
 
@@ -1379,7 +1516,7 @@ Example
1379
1516
  # Returns all E. coli glycans on the pathway map '00510'
1380
1517
  get_glycans_by_pathway('path:eco00510')
1381
1518
 
1382
- --- get_reactions_by_pathway(pathway_id)
1519
+ --- get_reactions_by_pathway(string:pathway_id)
1383
1520
 
1384
1521
  Retrieve all reactions on the specified pathway.
1385
1522
 
@@ -1390,7 +1527,7 @@ Example:
1390
1527
  # Returns all E. coli reactions on the pathway map '00260'
1391
1528
  get_reactions_by_pathway('path:eco00260')
1392
1529
 
1393
- --- get_kos_by_pathway(pathway_id)
1530
+ --- get_kos_by_pathway(string:pathway_id)
1394
1531
 
1395
1532
  Retrieve all KOs on the specified pathway.
1396
1533
 
@@ -1401,10 +1538,12 @@ Example:
1401
1538
  # Returns all ko_ids on the pathway map 'path:hsa00010'
1402
1539
  get_kos_by_pathway('path:hsa00010')
1403
1540
 
1404
-
1405
1541
  + Pathways by objects
1406
1542
 
1407
- --- get_pathways_by_genes(genes_id_list)
1543
+ Related site:
1544
+ * ((<URL:http://www.genome.jp/kegg/tool/search_pathway.html>))
1545
+
1546
+ --- get_pathways_by_genes([string]:genes_id_list)
1408
1547
 
1409
1548
  Search all pathways which include all the given genes. How to pass the
1410
1549
  list of genes_id will depend on the language specific implementations.
@@ -1416,7 +1555,7 @@ Example:
1416
1555
  # Returns all pathways including E. coli genes 'b0077' and 'b0078'
1417
1556
  get_pathways_by_genes(['eco:b0077' , 'eco:b0078'])
1418
1557
 
1419
- --- get_pathways_by_enzymes(enzyme_id_list)
1558
+ --- get_pathways_by_enzymes([string]:enzyme_id_list)
1420
1559
 
1421
1560
  Search all pathways which include all the given enzymes.
1422
1561
 
@@ -1427,7 +1566,7 @@ Example:
1427
1566
  # Returns all pathways including an enzyme '1.3.99.1'
1428
1567
  get_pathways_by_enzymes(['ec:1.3.99.1'])
1429
1568
 
1430
- --- get_pathways_by_compounds(compound_id_list)
1569
+ --- get_pathways_by_compounds([string]:compound_id_list)
1431
1570
 
1432
1571
  Search all pathways which include all the given compounds.
1433
1572
 
@@ -1438,7 +1577,7 @@ Example:
1438
1577
  # Returns all pathways including compounds 'C00033' and 'C00158'
1439
1578
  get_pathways_by_compounds(['cpd:C00033', 'cpd:C00158'])
1440
1579
 
1441
- --- get_pathways_by_glycans(glycan_id_list)
1580
+ --- get_pathways_by_glycans([string]:glycan_id_list)
1442
1581
 
1443
1582
  Search all pathways which include all the given glycans.
1444
1583
 
@@ -1449,7 +1588,7 @@ Example
1449
1588
  # Returns all pathways including glycans 'G00009' and 'G00011'
1450
1589
  get_pathways_by_glycans(['gl:G00009', 'gl:G00011'])
1451
1590
 
1452
- --- get_pathways_by_reactions(reaction_id_list)
1591
+ --- get_pathways_by_reactions([string]:reaction_id_list)
1453
1592
 
1454
1593
  Retrieve all pathways which include all the given reaction_ids.
1455
1594
 
@@ -1461,7 +1600,7 @@ Example:
1461
1600
  # 'rn:R00960' and 'rn:R01786'
1462
1601
  get_pathways_by_reactions(['rn:R00959', 'rn:R02740', 'rn:R00960', 'rn:R01786'])
1463
1602
 
1464
- --- get_pathways_by_kos(ko_id_list, org)
1603
+ --- get_pathways_by_kos([string]:ko_id_list, string:org)
1465
1604
 
1466
1605
  Retrieve all pathways of the organisms which include all the given KO IDs.
1467
1606
 
@@ -1475,10 +1614,9 @@ Example:
1475
1614
  # Returns pathways of all organisms including 'ko:K00016' and 'ko:K00382'
1476
1615
  get_pathways_by_kos(['ko:K00016', 'ko:K00382'], 'all')
1477
1616
 
1478
-
1479
1617
  + Relation among pathways
1480
1618
 
1481
- --- get_linked_pathways(pathway_id)
1619
+ --- get_linked_pathways(string:pathway_id)
1482
1620
 
1483
1621
  Retrieve all pathways which are linked from a given pathway_id.
1484
1622
 
@@ -1489,7 +1627,6 @@ Example:
1489
1627
  # Returns IDs of PATHWAY entries linked from 'path:eco00620'.
1490
1628
  get_linked_pathways('path:eco00620')
1491
1629
 
1492
-
1493
1630
  ==== GENES
1494
1631
 
1495
1632
  This section describes the APIs for GENES database. For more details
@@ -1497,7 +1634,7 @@ on GENES database, see:
1497
1634
 
1498
1635
  * ((<URL:http://www.genome.jp/kegg/kegg2.html#genes>))
1499
1636
 
1500
- --- get_genes_by_organism(org, start, max_results)
1637
+ --- get_genes_by_organism(string:org, int:offset, int:limit)
1501
1638
 
1502
1639
  Retrieve all genes of the specified organism.
1503
1640
 
@@ -1509,7 +1646,6 @@ Example:
1509
1646
  get_genes_by_organism('hin', 1, 100)
1510
1647
  get_genes_by_organism('hin', 101, 100)
1511
1648
 
1512
-
1513
1649
  ==== GENOME
1514
1650
 
1515
1651
  This section describes the APIs for GENOME database. For more details
@@ -1517,7 +1653,7 @@ on GENOME database, see:
1517
1653
 
1518
1654
  * ((<URL:http://www.genome.jp/kegg/kegg2.html#genome>))
1519
1655
 
1520
- --- get_number_of_genes_by_organism(org)
1656
+ --- get_number_of_genes_by_organism(string:org)
1521
1657
 
1522
1658
  Get the number of genes coded in the specified organism's genome.
1523
1659
 
@@ -1528,12 +1664,14 @@ Example:
1528
1664
  # Get the number of the genes on the E.coli genome.
1529
1665
  get_number_of_genes_by_organism('eco')
1530
1666
 
1531
-
1532
1667
  ==== LIGAND
1533
1668
 
1534
1669
  This section describes the APIs for LIGAND database.
1535
1670
 
1536
- --- convert_mol_to_kcf(mol_text)
1671
+ Related site:
1672
+ * ((<URL:http://www.genome.jp/kegg/ligand.html>))
1673
+
1674
+ --- convert_mol_to_kcf(string:mol)
1537
1675
 
1538
1676
  Convert a MOL format into the KCF format.
1539
1677
 
@@ -1543,10 +1681,163 @@ Return value:
1543
1681
  Example:
1544
1682
  convert_mol_to_kcf(mol_str)
1545
1683
 
1684
+ --- search_compounds_by_name(string:name)
1685
+
1686
+ Returns a list of compounds having the specified name.
1687
+
1688
+ Return value:
1689
+ ArrayOfstring (compound_id)
1690
+
1691
+ Example:
1692
+ search_compounds_by_name("shikimic acid")
1693
+
1694
+ --- search_drugs_by_name(string:name)
1695
+
1696
+ Returns a list of drugs having the specified name.
1697
+
1698
+ Return value:
1699
+ ArrayOfstring (drug_id)
1700
+
1701
+ Example:
1702
+ search_drugs_by_name("tetracyclin")
1703
+
1704
+ --- search_glycans_by_name(string:name)
1705
+
1706
+ Returns a list of glycans having the specified name.
1707
+
1708
+ Return value:
1709
+ ArrayOfstring (glycan_id)
1710
+
1711
+ Example:
1712
+ search_glycans_by_name("Paragloboside")
1713
+
1714
+ --- search_compounds_by_composition(string:composition)
1715
+
1716
+ Returns a list of compounds containing elements indicated by the composition.
1717
+ Order of the elements is insensitive.
1718
+
1719
+ Return value:
1720
+ ArrayOfstring (compound_id)
1721
+
1722
+ Example:
1723
+ search_compounds_by_composition("C7H10O5")
1724
+
1725
+ --- search_drugs_by_composition(string:composition)
1726
+
1727
+ Returns a list of drugs containing elements indicated by the composition.
1728
+ Order of the elements is insensitive.
1729
+
1730
+ Return value:
1731
+ ArrayOfstring (drug_id)
1732
+
1733
+ Example:
1734
+ search_drugs_by_composition("HCl")
1735
+
1736
+ --- search_glycans_by_composition(string:composition)
1737
+
1738
+ Returns a list of glycans containing sugars indicated by the composition.
1739
+ Order of the sugars (in parenthesis with number) is insensitive.
1740
+
1741
+ Return value:
1742
+ ArrayOfstring (glycan_id)
1743
+
1744
+ Example:
1745
+ search_glycans_by_composition("(Man)4 (GalNAc)1")
1746
+
1747
+ --- search_compounds_by_mass(float:mass, float:range)
1748
+
1749
+ Returns a list of compounds having the molecular weight around 'mass'
1750
+ with some ambiguity (range).
1751
+
1752
+ Return value:
1753
+ ArrayOfstring (compound_id)
1754
+
1755
+ Example:
1756
+ search_compounds_by_mass(174.05, 0.1)
1757
+
1758
+ --- search_drugs_by_mass(float:mass, float:range)
1759
+
1760
+ Returns a list of drugs having the molecular weight around 'mass'
1761
+ with some ambiguity (range).
1762
+
1763
+ Return value:
1764
+ ArrayOfstring (drug_id)
1765
+
1766
+ Example:
1767
+ search_drugs_by_mass(150, 1.0)
1768
+
1769
+ --- search_glycans_by_mass(float:mass, float:range)
1770
+
1771
+ Returns a list of glycans having a molecular weight around 'mass'
1772
+ with some ambiguity (range).
1773
+
1774
+ Return value:
1775
+ ArrayOfstring (glycan_id)
1776
+
1777
+ Example:
1778
+ search_glycans_by_mass(174.05, 0.1)
1779
+
1780
+ --- search_compounds_by_subcomp(string:mol, int:offset, int:limit)
1781
+
1782
+ Returns a list of compounds with the alignment having common sub-structure
1783
+ calculated by the subcomp program.
1784
+
1785
+ You can obtain a MOL formatted structural data of matched compounds
1786
+ using bget method with the "-f m" option to confirm the alignment.
1787
+
1788
+ Return value:
1789
+ ArrayOfStructureAlignment
1790
+
1791
+ Example:
1792
+ mol = bget("-f m cpd:C00111")
1793
+ search_compounds_by_subcomp(mol, 1, 5)
1794
+
1795
+ Related site:
1796
+ * ((<URL:http://www.genome.jp/ligand-bin/search_compound>))
1797
+
1798
+ --- search_drugs_by_subcomp(string:mol, int:offset, int:limit)
1799
+
1800
+ Returns a list of drugs with the alignment having common sub-structure
1801
+ calculated by the subcomp program.
1802
+
1803
+ You can obtain a MOL formatted structural data of matched drugs
1804
+ using bget method with the "-f m" option to confirm the alignment.
1805
+
1806
+ Return value:
1807
+ ArrayOfStructureAlignment
1808
+
1809
+ Example:
1810
+ mol = bget("-f m dr:D00201")
1811
+ search_drugs_by_subcomp(mol, 1, 5)
1812
+
1813
+ Related site:
1814
+ * ((<URL:http://www.genome.jp/ligand-bin/search_compound>))
1815
+
1816
+ --- search_glycans_by_kcam(string:kcf, string:program, string:option, int:offset, int:limit)
1817
+
1818
+ Returns a list of glycans with the alignment having common sub-structure
1819
+ calculated by the KCaM program.
1820
+
1821
+ The argument 'program' can be 'gapped' or 'ungaped'.
1822
+ The next argument 'option' can be 'global' or 'local'.
1823
+
1824
+ You can obtain a KCF formatted structural data of matched glycans
1825
+ using bget method with the "-f k" option to confirm the alignment.
1826
+
1827
+ Return value:
1828
+ ArrayOfStructureAlignment
1829
+
1830
+ Example:
1831
+ kcf = bget("-f k gl:G12922")
1832
+ search_glycans_by_kcam(kcf, "gapped", "local", 1, 5)
1833
+
1834
+ Related site:
1835
+ * ((<URL:http://www.genome.jp/ligand-bin/search_glycan.cgi>))
1836
+ * ((<URL:http://www.genome.jp/ligand/kcam/>))
1546
1837
 
1547
1838
  == Notes
1548
1839
 
1549
- Last updated: Feb 17, 2006
1840
+ Last updated: December 27, 2006
1550
1841
 
1551
1842
  =end
1552
1843