Module: BEL::Resource::Search::API

Defined in:
lib/bel/resource/search/api.rb

Instance Method Summary collapse

Instance Method Details

#search(query_expression, concept_type = nil, scheme_uri = nil, species = nil, options = {}) ⇒ Array<SearchResult>?

Search identifiers based on query_expression.

Additional parameters

concept_type:

Searches on namespace values when set to +namespace_concept+.
Searches on annotation values when set to +annotation_concept+.
Otherwise, searches either namespace values or annotation values. This is the default.

scheme_uri:

Searches within a specific namespace or annotation identified by this URI.
Otherwise, searches across all namespaces or annotations. This is the default.

species:

Searches for namespace values or annotation values represented within the provided species. Values from
the NCBI Taxonomy are recognized (e.g. 9606, Homo sapiens, Human, etc.).
Otherwise, searches across all values regardless of species.

options:

Options hash used to provide additional parameters to the search.

Parameters:

  • query_expression (responds to #to_s) —

    query expression

  • concept_type (responds to #to_s) (defaults to: nil) —

    concept type

  • scheme_uri (responds to #to_s) (defaults to: nil) —

    scheme uri

  • species (responds to #to_s) (defaults to: nil) —

    species

  • options (responds to #[]) (defaults to: {}) —

    options hash

Returns:



32
33
34
 
# File 'lib/bel/resource/search/api.rb', line 32

def search(query_expression, concept_type = nil, scheme_uri = nil, species = nil, options = {})
  fail NotImplementedError.new, "#{__method__} is not implemented"
end