addLabelToCol (
        self,
        label,
        col,
        )

Attatches a label to a particular column of the associated dataset.

addLabelToCols (
        self,
        label,
        colList,
        )

Attatches the label to all of the columns in colList. Uses addLabelToCol() underneath.

addLabelToKey (
        self,
        label,
        key,
        )

Attatches a label to a particular key of the associated dataset.

addLabelToKeys (
        self,
        label,
        keyList,
        )

Attatches the label to all of the keys in keyList. Uses addLabelToCol() underneath.

addLabelToRow (
        self,
        label,
        row,
        )

Attatches a label to a particular row of the associated dataset.

addLabelToRows (
        self,
        label,
        rowList,
        )

Attatches the label to all of the rows in rowList. Uses addLabelToRow() underneath.

addLabelsToCol (
        self,
        labels,
        col,
        )

Attatches a set of labels to a particular column.

addLabelsToCols (
        self,
        labels,
        cols,
        )

Attatches a list of label sets to a set of columns.

addLabelsToKey (
        self,
        labels,
        key,
        )

Attatches a set of labels to a particular key.

addLabelsToKeys (
        self,
        labels,
        keys,
        )

Attatches a list of label sets to a set of keys.

addLabelsToRow (
        self,
        labels,
        row,
        )

Attatches a set of labels to a particular row.

addLabelsToRows (
        self,
        labels,
        rows,
        )

Attatches a list of label sets to a set of rows.

detatch ( self )

Remove the labeling from the dataset.

This will remove all the data relevant to this labeling from the dataset and all references to the dataset. This method is not generally useful to a client program. Use IDataset.removeLabeling() to remove a labeling from a dataset object.

getAllColLabels ( self )

Returns a list of lists of the labels for all the columns.

getAllKeyLabels ( self )

Returns a list of lists of the labels for all the keys.

getAllRowLabels ( self )

Returns a list of lists of the labels for all the rows.

getColsByLabel ( self,  label )

Returns all the columns which are marked by the label given.

getDataset ( self )

Returns the dataset instance to which this labeling is bound.

getKeysByLabel ( self,  label )

Returns a list of keys marked by the specified label.

getLabelByCol (
        self,
        col,
        n=0,
        )

Gets the Nth label from a given column. Returns None if a label does not exist. By default this will return the first label in the list.

getLabelByKey (
        self,
        key,
        n=0,
        )

Gets the Nth label from a given key. Returns None if a label does not exist. By default this will return the first label in the list.

getLabelByRow (
        self,
        row,
        n=0,
        )

Gets the Nth label from a given row. Returns None if a label does not exist.

getLabels ( self )

Returns a list of all the labels this labeling has knowledge about.

getLabelsByCol ( self,  col )

Returns a list of all labels associated with a particular column

getLabelsByCols ( self,  cols )

Returns a list of lists of all labels from a set of columns.

getLabelsByKey ( self,  key )

Returns a list of labels for a specific key. The labels returned are only those created by this Labeling.

getLabelsByKeys ( self,  keys )

Returns a list of lists of all labels from a set of keys.

getLabelsByRow ( self,  row )

Returns a list of all labels associated with a particular row.

getLabelsByRows ( self,  rows )

Returns a list of lists of all labels from a set of rows.

getName ( self )

Returns the name of this labeling.

Names are indentifierd bestowed upon the labeling when it is created or at a later point via the setName() method. The name may be None.

getRowsByLabel ( self,  label )

Returns all the rows which are marked by the label.

labelCols ( self,  obj )

Labels all columns with the contents of the the object.

Performs identically to labelRows(), except on columns.

labelFrom (
        self,
        labeling,
        name=None,
        )

Creates and returns a labeling for the dataset based on the labeling of a different view or dataset.

If the given labeling is already attatched to the dataset, no action is performed and None is returned. In the case where the Labeling is attatched to a different dataset, the common datapoints will be labeled with the same labels that Labeling contains.

Example usage:

view1 = dataset.subsetRows([0,1,2,3,4]) view2 = dataset.subsetRows([2,3,4,5,6])

labeling1 = Labeling(view1) labeling1.addLabelToRows("top5", range(view1.getNumRows()))

// // Now use labeling1 to label view2 //

labeling2 = Labeling(view2) labeling2.labelFrom(labeling1)

// // The common datapoints (2,3,4) are now labeled with "top5" and may // be retieved //

num = len(labeling2.getRowsByLabel("top5")) print str(num) + " of my top 5 genes are in this dataset"

labelRows ( self,  obj )

Labels all the rows with the contents of the object.

labelRows() casts the object to a list of hashable python objects and then labels the rows of the dataset with the resulting objects. See the _castLabels() method for details on how different objects are cast.

removeAll ( self )

Removes all the labels in the labeling and unmarks every key in the dataset which is marked by this Labeling. Labels attatched to keys by other labelings are not affected.

removeLabel ( self,  label )

Removes a label and unmarks all the keys in the dataset associated with the label.

removeLabelFromCol (
        self,
        label,
        col,
        )

Remove a single label from a given column.

removeLabelFromKey (
        self,
        label,
        key,
        )

Remove a single label from a single key.

removeLabelFromRow (
        self,
        label,
        row,
        )

Remove a single label from a given row.

removeLabelsFromCol ( self,  col )

removeLabelsFromCol(row)

Removes all the labels in this Labeling from a specified column of the dataset.

removeLabelsFromKey ( self,  key )

Removes all the labels in this Labeling from a specified key of the dataset.

removeLabelsFromRow ( self,  row )

Removes all the labels in this Labeling from a specified row of the dataset.

setName ( self,  name )

Sets the name for the labeling.

This method replaces the current LAbeling name with the one specified.

sortDatasetByLabel ( self )

Row sorts a SortedView via labeling information.

This method only works if the labeling is attatched to a sorted view (or derivative).

writeLabels (
        self,
        stream=sys.stdout,
        delimiter="\t",
        )

Prints out all row labels to the specified stream.

The labels will be written out in row order from smallest to largest. If there is more than one label on a line, the labels are separated by the specified delimiter.