module EnsemblRest::Information

Public Class Methods

assembly_info(species, opts = {}) click to toggle source

Returns information about the current available assemblies in this given species

# File lib/bio-ensembl-rest/information.rb, line 6
def self.assembly_info(species, opts = {})
  opts = EnsemblRest.parse_options opts
  path = EnsemblRest.build_path "/assembly/info/#{species}", opts

  if opts['content-type'] == 'ruby'
    plain_opts = opts.clone
    plain_opts['content-type'] = 'application/json'
    return JSON.parse assembly_info species, plain_opts
  end

  return EnsemblRest.fetch_data path, opts, 'information'  
end
assembly_info_region(species, region, opts = {}) click to toggle source

Returns information about the given toplevel sequence region given to this endpoint

# File lib/bio-ensembl-rest/information.rb, line 22
def self.assembly_info_region(species, region, opts = {})
  opts = EnsemblRest.parse_options opts
  path = EnsemblRest.build_path "/assembly/info/#{species}/#{region}", opts

  if opts['content-type'] == 'ruby'
    plain_opts = opts.clone
    plain_opts['content-type'] = 'application/json'
    return JSON.parse assembly_info_region species, plain_opts
  end

  return EnsemblRest.fetch_data path, opts, 'information'        
end
info_analysis(species, opts = {}) click to toggle source

Lists the available analyses by logic name and the database type those logic names are found in.

# File lib/bio-ensembl-rest/information.rb, line 38
def self.info_analysis(species, opts = {})
  opts = EnsemblRest.parse_options opts
  path = EnsemblRest.build_path "/info/analysis/#{species}", opts

  if opts['content-type'] == 'ruby'
    plain_opts = opts.clone
    plain_opts['content-type'] = 'application/json'
    return JSON.parse info_analysis species, plain_opts
  end

  return EnsemblRest.fetch_data path, opts, 'information'  
end
info_biotypes(species, opts = {}) click to toggle source

Lists all available biotypes for the given species.

# File lib/bio-ensembl-rest/information.rb, line 54
def self.info_biotypes(species, opts = {})
  opts = EnsemblRest.parse_options opts
  path = EnsemblRest.build_path "/info/biotypes/#{species}", opts

  if opts['content-type'] == 'ruby'
    plain_opts = opts.clone
    plain_opts['content-type'] = 'application/json'
    return JSON.parse info_biotypes species, plain_opts
  end

  return EnsemblRest.fetch_data path, opts, 'information'  
end
info_compara_methods(opts = {}) click to toggle source
# File lib/bio-ensembl-rest/information.rb, line 69
def self.info_compara_methods(opts = {})
  opts = EnsemblRest.parse_options opts
  path = EnsemblRest.build_path "/info/compara/methods", opts

  if opts['content-type'] == 'ruby'
    plain_opts = opts.clone
    plain_opts['content-type'] = 'application/json'
    return JSON.parse info_compara_methods plain_opts
  end

  return EnsemblRest.fetch_data path, opts, 'information' 
end
info_compara_species_sets_method(method, opts = {}) click to toggle source
# File lib/bio-ensembl-rest/information.rb, line 85
def self.info_compara_species_sets_method(method, opts = {})
  opts = EnsemblRest.parse_options opts
  path = EnsemblRest.build_path "/info/compara/species_sets/#{method}", opts

  if opts['content-type'] == 'ruby'
    plain_opts = opts.clone
    plain_opts['content-type'] = 'application/json'
    return JSON.parse info_compara_species_sets_method method, plain_opts
  end

  return EnsemblRest.fetch_data path, opts, 'information' 
end
info_comparas(opts = {}) click to toggle source

Lists all available comparative genomics databases and their data release

# File lib/bio-ensembl-rest/information.rb, line 102
def self.info_comparas(opts = {})
  opts = EnsemblRest.parse_options opts
  path = EnsemblRest.build_path "/info/comparas", opts

  if opts['content-type'] == 'ruby'
    plain_opts = opts.clone
    plain_opts['content-type'] = 'application/json'
    return JSON.parse info_comparas plain_opts
  end

  return EnsemblRest.fetch_data path, opts, 'information'      
end
info_data(opts = {}) click to toggle source

Shows the data releases available on this REST server

# File lib/bio-ensembl-rest/information.rb, line 118
def self.info_data(opts = {})
  opts = EnsemblRest.parse_options opts
  path = EnsemblRest.build_path "/info/data", opts

  if opts['content-type'] == 'ruby'
    plain_opts = opts.clone
    plain_opts['content-type'] = 'application/json'
    return JSON.parse info_data plain_opts
  end

  return EnsemblRest.fetch_data path, opts, 'information'      
end
info_ping(opts = {}) click to toggle source

Pings the first available DBAdaptor to see if the service is still active

# File lib/bio-ensembl-rest/information.rb, line 134
def self.info_ping(opts = {})
  opts = EnsemblRest.parse_options opts
  path = EnsemblRest.build_path "/info/ping", opts

  if opts['content-type'] == 'ruby'
    plain_opts = opts.clone
    plain_opts['content-type'] = 'application/json'
    return JSON.parse info_ping plain_opts
  end

  return EnsemblRest.fetch_data path, opts, 'information' 
end
info_rest(opts = {}) click to toggle source

Shows the current version of the REST API

# File lib/bio-ensembl-rest/information.rb, line 150
 def self.info_rest(opts = {})
  opts = EnsemblRest.parse_options opts
  path = EnsemblRest.build_path "/info/rest", opts

  if opts['content-type'] == 'ruby'
    plain_opts = opts.clone
    plain_opts['content-type'] = 'application/json'
    return JSON.parse info_rest plain_opts
  end

  return EnsemblRest.fetch_data path, opts, 'information' 
end
info_software(opts = {}) click to toggle source

Shows the current version of the Ensembl API

# File lib/bio-ensembl-rest/information.rb, line 166
 def self.info_software(opts = {})
  opts = EnsemblRest.parse_options opts
  path = EnsemblRest.build_path "/info/software", opts

  if opts['content-type'] == 'ruby'
    plain_opts = opts.clone
    plain_opts['content-type'] = 'application/json'
    return JSON.parse info_software plain_opts
  end

  return EnsemblRest.fetch_data path, opts, 'information' 
end
info_species(opts = {}) click to toggle source

Lists all available species, their aliases, available adaptor groups and data release

# File lib/bio-ensembl-rest/information.rb, line 182
 def self.info_species(opts = {})
  opts = EnsemblRest.parse_options opts
  path = EnsemblRest.build_path "/info/species", opts

  if opts['content-type'] == 'ruby'
    plain_opts = opts.clone
    plain_opts['content-type'] = 'application/json'
    return JSON.parse info_species plain_opts
  end

  return EnsemblRest.fetch_data path, opts, 'information' 
end