entrez 0.1.0 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/README.rdoc +28 -0
- data/lib/entrez/version.rb +1 -1
- metadata +3 -2
data/README.rdoc
ADDED
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
= Entrez
|
|
2
|
+
|
|
3
|
+
Entrez is a simple API for making HTTP requests to Entrez utilities (eutils: http://eutils.ncbi.nlm.nih.gov/).
|
|
4
|
+
|
|
5
|
+
== Usage
|
|
6
|
+
|
|
7
|
+
Entrez.efetch(<database>, parameters)
|
|
8
|
+
|
|
9
|
+
== Example
|
|
10
|
+
|
|
11
|
+
Entrez.efetch('snp', {id: '9268480', retmode: 'xml'})
|
|
12
|
+
will return an xml document with information about rs9268480.
|
|
13
|
+
It's up to you to parse the document.
|
|
14
|
+
|
|
15
|
+
== Email & Tool
|
|
16
|
+
|
|
17
|
+
NCBI (or wheover) requests that you supply the tool you are using and your email.
|
|
18
|
+
The Entrez gem uses 'ruby' as the tool.
|
|
19
|
+
Email is obtained from an environment variable ENTREZ_EMAIL on your computer.
|
|
20
|
+
I set mine in my ~/.bash_profile:
|
|
21
|
+
export ENTREZ_EMAIL='jared@redningja.com'
|
|
22
|
+
|
|
23
|
+
== What about EInfo, ESummary, EPost, ESearch, ELink, EGQuery, and ESpell?
|
|
24
|
+
|
|
25
|
+
For my purposes, I only needed EFetch.
|
|
26
|
+
But if you would like to contribute, please feel free.
|
|
27
|
+
After seeing the code, assuming you know how to submit requests to einfo et al,
|
|
28
|
+
It should be trivial to implement them here.
|
data/lib/entrez/version.rb
CHANGED
metadata
CHANGED
|
@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
|
|
|
5
5
|
segments:
|
|
6
6
|
- 0
|
|
7
7
|
- 1
|
|
8
|
-
-
|
|
9
|
-
version: 0.1.
|
|
8
|
+
- 1
|
|
9
|
+
version: 0.1.1
|
|
10
10
|
platform: ruby
|
|
11
11
|
authors:
|
|
12
12
|
- Jared Ning
|
|
@@ -58,6 +58,7 @@ files:
|
|
|
58
58
|
- .gitignore
|
|
59
59
|
- .rvmrc
|
|
60
60
|
- Gemfile
|
|
61
|
+
- README.rdoc
|
|
61
62
|
- Rakefile
|
|
62
63
|
- entrez.gemspec
|
|
63
64
|
- lib/entrez.rb
|