module EnsemblREST::Lookup

Public Instance Methods

id(id, options = {}) click to toggle source

Find the species and database for a single identifier

@param [String] id An Ensembl Stable ID @param [Hash] options Optional arguments for the service please goto rest.ensembl.org/documentation/info/lookup @return [JSON] Cross references

# File lib/ensemblrest/lookup.rb, line 31
def id(id, options = {})
        return EnsemblREST.get("lookup/id/#{id}", {format: 'json'}.merge(options))
end
id_post(ids, options = {}) click to toggle source

Find the species and database for several identifiers. IDs that are not found are returned with no data.

@param [String] ids Ensembl Stable IDs @param [Hash] options Optional arguments for the service please goto rest.ensembl.org/documentation/info/lookup_post @return [JSON] Cross references

# File lib/ensemblrest/lookup.rb, line 50
def id_post(ids, options = {})
        return EnsemblREST.post("lookup/id", {'ids' => ids}, {format: 'json'}.merge(options))
end
symbol(symbol, species = 'human', options = {}) click to toggle source

Find the species and database for a symbol in a linked external database

@param [String] symbol A name or symbol from an annotation source has been linked to a genetic feature @param [String] species Species name/alias @param [Hash] options Optional arguments for the service please goto rest.ensembl.org/documentation/info/symbol_lookup @return [JSON] Cross references

# File lib/ensemblrest/lookup.rb, line 22
def symbol(symbol, species = 'human', options = {})
        return EnsemblREST.get("lookup/symbol/#{species}/#{symbol}", {format: 'json'}.merge(options))
end
symbol_post(symbols, species = 'human', options = {}) click to toggle source

Find the species and database for a set of symbols in a linked external database. Unknown symbols are omitted from the response.

@param [String] symbols An array of names or symbols from an annotation source has been linked to a genetic feature @param [String] species Species name/alias @param [Hash] options Optional arguments for the service please goto rest.ensembl.org/documentation/info/symbol_post @return [JSON] Cross references

# File lib/ensemblrest/lookup.rb, line 41
def symbol_post(symbols, species = 'human', options = {})
        return EnsemblREST.post("lookup/symbol/#{species}", {'symbols' => symbols}, {format: 'json'}.merge(options))
end