Module: EnsemblREST::Taxonomy

Defined in:

lib/ensemblrest/ontoandtaxo.rb

Class Method Summary

• .classification(id, options = {}) ⇒ JSON

  Return the taxonomic classification of a taxon node.

• .id(id, options = {}) ⇒ JSON

  Search for a taxonomic term by its identifier or name.

• .name(name, options = {}) ⇒ JSON

  Search for a taxonomic id by a non-scientific name.

Class Method Details

.classification(id, options = {}) ⇒ JSON

Return the taxonomic classification of a taxon node

Parameters:

• id (String) —

  A taxon identifier. Can be a NCBI taxon id or a name

• options (Hash) (defaults to: {}) —

  Optional arguments for the service please goto rest.ensembl.org/documentation/info/taxonomy_classification

Returns:

• (JSON) —

  the taxonomic classification

# File 'lib/ensemblrest/ontoandtaxo.rb', line 73

def classification(id, options = {})
	return EnsemblREST.get("taxonomy/classification/#{id}", {format: 'json'}.merge(options))
end

.id(id, options = {}) ⇒ JSON

Search for a taxonomic term by its identifier or name

Parameters:

• id (String) —

  A taxon identifier. Can be a NCBI taxon id or a name

• options (Hash) (defaults to: {}) —

  Optional arguments for the service please goto rest.ensembl.org/documentation/info/taxonomy_id

Returns:

• (JSON) —

  the taxonomic classification

# File 'lib/ensemblrest/ontoandtaxo.rb', line 82

def id(id, options = {})
	return EnsemblREST.get("taxonomy/id/#{id}", {format: 'json'}.merge(options))
end

.name(name, options = {}) ⇒ JSON

Search for a taxonomic id by a non-scientific name

Parameters:

• name (String) —

  A non-scientific species name. Can include SQL wildcards

• options (Hash) (defaults to: {}) —

  Optional arguments for the service please goto rest.ensembl.org/documentation/info/taxonomy_name

Returns:

• (JSON) —

  the taxonomic classification

# File 'lib/ensemblrest/ontoandtaxo.rb', line 91

def name(name, options = {})
	return EnsemblREST.get("taxonomy/name/#{URI.escape(name)}", {format: 'json'}.merge(options))
end