blend4php  v0.1
A PHP API for interacting with Galaxy
 All Classes Functions Variables Pages
GalaxyGenomes Class Reference

Public Member Functions

 __construct (GalaxyInstance $galaxy)
 
 index ()
 
 show ($genome_id)
 

Constructor & Destructor Documentation

GalaxyGenomes::__construct ( GalaxyInstance  $galaxy)

The Genomes constructor.

Parameters
GalaxyInstance$galaxyA GalaxyInstance object.
Returns
An instance of a Genomes object.

Member Function Documentation

GalaxyGenomes::index ( )

Returns a list of installed genomes.

Corresponds to the Galaxy api function/path: GET /api/genomes

Returns
An array containing a list of all of the genome entities in Galaxy.
GalaxyGenomes::show (   $genome_id)

Returns detailed information about a specific Galaxy genome.

Corresponds to the Galaxy api function/path: GET /api/genomes/{encodedGenomeid}

Parameters
$genome_idThe id of the genome to examine. To obtained genome id's please use this class's index() funciton.
Returns
An array containing detailed information about the specified Galaxy Genome.

The documentation for this class was generated from the following file: