Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

rdoc formatting

  • Loading branch information...
commit de3489818e826c46aa7e0802c3e6c6b5e1e99750 1 parent ab72b48
Jose Irizarry authored October 08, 2011

Showing 1 changed file with 18 additions and 21 deletions. Show diff stats Hide diff stats

  1. 39  README.rdoc
39  README.rdoc
Source Rendered
@@ -6,37 +6,33 @@ http://portal.ncibi.org/gateway/
6 6
 
7 7
 http://mimi.ncibi.org/MimiWeb/main-page.jsp
8 8
 
9  
-= Usage
  9
+== Usage
10 10
 
11  
-There are four methods on the Mimiweb Web Service. With this client you can access them as follows
  11
+  require 'mimiweb'
12 12
 
13  
-== Free text search
  13
+  # Free text search
  14
+	results = Mimiweb.search("pwp1")
14 15
 
15  
-ruby-1.9.2-p290 :001 > results = Mimiweb.search("pwp1")
  16
+  # GeneID search (Entrez)
  17
+ 	results = Mimiweb.entrez(1436)
  18
+  
  19
+  # Or pass a type. Types are: compounds, interactions, reactions, nlp.
  20
+  # Default = :interactions
16 21
 
17  
-== GeneID search
  22
+	results = Mimiweb.entrez(7389, :compounds)
18 23
 
19  
-ruby-1.9.2-p290 :001 > results = Mimiweb.entrez(1436)
20 24
 
21  
-or
  25
+  # KEGG CompundID search
  26
+	results = Mimiweb.kegg_compund("C00061")
22 27
 
23  
-Pass a type as a second parameter
24  
-[types]
25  
-	:compounds
26  
-	:reactions
27  
-	:nlp
28  
-	:interactions # default
  28
+  # KEGG ReactionID search
29 29
 
30  
-ruby-1.9.2-p290 :001 > results = Mimiweb.entrez(1436, type)
  30
+	results = Mimiweb.kegg_reaction("R00548")
31 31
 
32 32
 
33  
-== KEGG CompundID search
  33
+== To Do
34 34
 
35  
-ruby-1.9.2-p290 :001 > results = Mimiweb.kegg_compund("C00061")
36  
-
37  
-== KEGG ReactionID search
38  
-
39  
-ruby-1.9.2-p290 :001 > results = Mimiweb.kegg_reaction("R00548")
  35
+* Tests!
40 36
 
41 37
 == Contributing to mimiweb
42 38
  
@@ -51,4 +47,5 @@ ruby-1.9.2-p290 :001 > results = Mimiweb.kegg_reaction("R00548")
51 47
 == Copyright
52 48
 
53 49
 Copyright (c) 2011 Jose Irizarry. See LICENSE.txt for
54  
-further details.
  50
+further details.
  51
+

0 notes on commit de34898

Please sign in to comment.
Something went wrong with that request. Please try again.