Module: EnsemblREST::Sequence

Defined in:
lib/ensemblrest/sequence.rb

Class Method Summary collapse

Class Method Details

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

Request multiple types of sequence by stable identifier.

Parameters:

Returns:

  • (FastaFormat) —

    requested sequence



22
23
24
 
# File 'lib/ensemblrest/sequence.rb', line 22

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

.id_post(ids, options = {}) ⇒ JSON

Request multiple types of sequence by a stable identifier list.

Parameters:

Returns:

  • (JSON) —

    Requested response



41
42
43
 
# File 'lib/ensemblrest/sequence.rb', line 41

def id_post(ids, options = {})
	return EnsemblREST.post("sequence/id", {"ids" => ids}, {format: 'json'}.merge(options))
end

.region(region, species = 'human', options = {}) ⇒ FastaFormat

Returns the genomic sequence of the specified region of the given species.

Parameters:

  • regionQuery (String) —

    region. A maximum of 10Mb is allowed to be requested at any one time

  • species (String) (defaults to: 'human') —

    Species name/alias

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

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

Returns:

  • (FastaFormat) —

    requested sequence



32
33
34
 
# File 'lib/ensemblrest/sequence.rb', line 32

def region(region, species = 'human', options = {})
	return EnsemblREST.get("sequence/region/#{species}/#{region}", {format: 'fasta'}.merge(options))
end

.region_post(regions, species = 'human', options = {}) ⇒ JSON

Request multiple types of sequence by a list of regions.

Parameters:

  • regions (Array) —

    Query regions. A maximum of 10Mb is allowed to be requested at any one time

  • species (String) (defaults to: 'human') —

    Species name/alias

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

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

Returns:

  • (JSON) —

    Requested response



51
52
53
 
# File 'lib/ensemblrest/sequence.rb', line 51

def region_post(regions, species = 'human', options = {})
	return EnsemblREST.post("sequence/region/#{species}", {"regions" => regions}, {format: 'json'}.merge(options))
end