Permalink
Browse files

rdoc formatting

  • Loading branch information...
1 parent ab72b48 commit de3489818e826c46aa7e0802c3e6c6b5e1e99750 @crm114 committed Oct 8, 2011
Showing with 18 additions and 21 deletions.
  1. +18 −21 README.rdoc
View
39 README.rdoc
@@ -6,37 +6,33 @@ http://portal.ncibi.org/gateway/
http://mimi.ncibi.org/MimiWeb/main-page.jsp
-= Usage
+== Usage
-There are four methods on the Mimiweb Web Service. With this client you can access them as follows
+ require 'mimiweb'
-== Free text search
+ # Free text search
+ results = Mimiweb.search("pwp1")
-ruby-1.9.2-p290 :001 > results = Mimiweb.search("pwp1")
+ # GeneID search (Entrez)
+ results = Mimiweb.entrez(1436)
+
+ # Or pass a type. Types are: compounds, interactions, reactions, nlp.
+ # Default = :interactions
-== GeneID search
+ results = Mimiweb.entrez(7389, :compounds)
-ruby-1.9.2-p290 :001 > results = Mimiweb.entrez(1436)
-or
+ # KEGG CompundID search
+ results = Mimiweb.kegg_compund("C00061")
-Pass a type as a second parameter
-[types]
- :compounds
- :reactions
- :nlp
- :interactions # default
+ # KEGG ReactionID search
-ruby-1.9.2-p290 :001 > results = Mimiweb.entrez(1436, type)
+ results = Mimiweb.kegg_reaction("R00548")
-== KEGG CompundID search
+== To Do
-ruby-1.9.2-p290 :001 > results = Mimiweb.kegg_compund("C00061")
-
-== KEGG ReactionID search
-
-ruby-1.9.2-p290 :001 > results = Mimiweb.kegg_reaction("R00548")
+* Tests!
== Contributing to mimiweb
@@ -51,4 +47,5 @@ ruby-1.9.2-p290 :001 > results = Mimiweb.kegg_reaction("R00548")
== Copyright
Copyright (c) 2011 Jose Irizarry. See LICENSE.txt for
-further details.
+further details.
+

0 comments on commit de34898

Please sign in to comment.