Skip to content

GET data microarray

Jalil F. edited this page Jul 30, 2013 · 5 revisions

Overview

This REST request is used to pull microarray data with specified values. Logically, microarray data is built from geneset selections, so drilldowns of microarrays are not encouraged. Send microarray selections to a new geneset by using POST data/geneset to build a new subset of the geneset.

Parameters

id (required)

Unique identification number for user's saved microarray set. Get a list of users microarrays using the GET user/microarrays call.

format (required)

Type of return format. Valid values currently supported are "json".

page (optional)

Integer of page of requested objects. Current limit for pages is 75 rows. If page is not specified, all microarray data will be returned if the number of rows is less than 1000.

color (optional)

A color code for users who wish to build a heatmap in a color specified by our supported heatmap colors.

Returns

Object

Attributes:

id (string) : The id of the returned microarray

page_id (integer) : The current page of the returned microarray.

total_pages (integer) : The number of total pages in the current microarray set.

data (object) : Object with data to build heatmap. Current attributes are listed below.

  • rows - number of rows
  • columns - number of columns
  • rowlabels -list of row labels in the returned values
  • columnlabels - list of column labels in the returned values
  • values - list of objects for each cell of the microarray with attributes "col", "row", and "value", mappable for d3 use.

Example Request

GET microarray/id=affy.first20?format=json&page=1&color=green-red

We are requesting the microarray with id "affy.first20", in the format of "json", with a color code of green-red

Example Return

{
    "id": "affy.first20",
    "page_id": 1,
    "total_pages": 1,
    "color": "green-red",
    "data": {
        "rows": 4,
        "columns": 4,
        "rowlabels": [
            "row0",
            "row1",
            ...
        ],
        "columnlabels": [
            "Time1",
            "Time2",
            ...
        ],
        "values": [
            {
                "col": "Time1",
                "value": 0,
                "row": "row0"
            },
            {
                "col": "Time2",
                "value": 0,
                "row": "row0"
            },
            ...
        ]
    }
}

Clone this wiki locally