class Bio::NCBI
Constants
- ENTREZ_DEFAULT_PARAMETERS
(Hash) Default parameters for Entrez (eUtils). They may also be used for other NCBI services.
Public Class Methods
default_email()
click to toggle source
Gets default email address for Entrez (eUtils).
- Returns
-
String or nil
# File lib/bio/io/ncbirest.rb, line 42 def self.default_email ENTREZ_DEFAULT_PARAMETERS['email'] end
default_email=(str)
click to toggle source
Sets default email address used for Entrez (eUtils). It may also be used for other NCBI services.
Arguments:
-
(required) str: (String) email address
- Returns
-
same as given argument
# File lib/bio/io/ncbirest.rb, line 52 def self.default_email=(str) ENTREZ_DEFAULT_PARAMETERS['email'] = str end
default_tool()
click to toggle source
Gets default tool name for Entrez (eUtils).
- Returns
-
String or nil
# File lib/bio/io/ncbirest.rb, line 59 def self.default_tool ENTREZ_DEFAULT_PARAMETERS['tool'] end
default_tool=(str)
click to toggle source
Sets default tool name for Entrez (eUtils). It may also be used for other NCBI services.
Arguments:
-
(required) str: (String) tool name
- Returns
-
same as given argument
# File lib/bio/io/ncbirest.rb, line 69 def self.default_tool=(str) ENTREZ_DEFAULT_PARAMETERS['tool'] = str end
reset_entrez_default_parameters()
click to toggle source
Resets Entrez (eUtils) default parameters.
- Returns
-
(Hash) default parameters
# File lib/bio/io/ncbirest.rb, line 30 def self.reset_entrez_default_parameters h = { 'tool' => "#{$0} (bioruby/#{Bio::BIORUBY_VERSION_ID})", 'email' => nil, } ENTREZ_DEFAULT_PARAMETERS.clear ENTREZ_DEFAULT_PARAMETERS.update(h) end