GalaxyDatasets Class Reference

Public Member Functions
	__construct ($galaxy)
	converted ($params)
	display ($params)
	index ()
	show ($params)

Constructor & Destructor Documentation

GalaxyDatasets::__construct

(

$galaxy

)

The DataSets constructor.

Parameters

GalaxyInstance

$galaxy

A GalaxyInstance object.

Returns

An instance of a DataSet object.

Member Function Documentation

GalaxyDatasets::converted

(

$params

)

Retreive information about datasets made by converting to a new file format.

Corresponds to the galaxy API function at: GET /api/datasets/{dataset_id}/converted/{ext}

Parameters

$params

An associative array containing the input parameters for this function. The following parameters are available:

• dataset_id: The dataset id of the information to pull. Can be obtained from this function's display().
• extension (optional): If supplied this will look at the file extension.

Returns

An array containing information about the matching dataset(s).

GalaxyDatasets::display

(

$params

)

Retreives a list of datasets associated with a given history.

Corresponds to the Galaxy Api method and path: GET /api/histories/{encoded_history_id}/contents/{encoded_content_id}/display history content (dataset).

Parameters

$params

An associative array containing the input parameters for this function. The following parameters are available:

• hist_id: The history id of the datasets to find.
• hist_content_id: The specified history content's dataset(s) to list. Please see the HistoryContents class to obtain the history content id

Returns

An array containing information about the matching dataset(s).

GalaxyDatasets::index

(

)

Retreives a list of all datasets.

Currently not supported by the Galaxy API

GalaxyDatasets::show

(

$params

)

Retreives detailed content on a specific dataset.

Corresponds to the Galaxy Api function and path: GET /api/datasets/{encoded_dataset_id}

Parameters

$params

An associative array containing the input parameters for this function. The following parameters are available:

• dataset_id: The dataset_id's information that the function is to retreive. To obtain the dataset id, please use the Display function.

Returns

An array containing information about the matching dataset.

---

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

• DataSets.inc