Skip to content
jandot edited this page Sep 14, 2010 · 27 revisions

Introduction & history

The ruby ensembl API was first devised by Jan Aerts in June 2007 on release 45 of the core database. The purpose of the API was basically to mimick all functionality that’s available in the perl API for that database. With the help of the Ensembl core team, the API for the core database was worked out while being a “Geek for a Week”. The API is based on Ensembl release 45, but is expected to work (mostly) on later releases as well.

At the moment only the core database is covered, leaving others like funcgen, other_features and variation. Hopefully these will be added in the future. Marc Hoeppner from Stockholm University is working on the compara part.

Installation

The API is made available as a gem from gems.github.com. To install, type


sudo gem install jandot-ruby-ensembl-api —source http://gems.github.com

To help in the development, feel free to fork this repository.

Documentation

Although this wiki might provide documentation in the future, all rdoc documentation and a tutorial are now still available at the original rubyforge project page.

Source control

The API has been kept under subversion source control at rubyforge (http://bioruby-annex.rubyforge.org), but has recently been moved to github.

Clone this wiki locally