emperor.Emperor.shape_by¶

Emperor.shape_by(category, shapes=None)¶

Set the shape settings for the plot elements

Parameters:

Parameters:	category: str Name of the metadata column. shapes: dict or pd.Series, optional Mapping of categories to string values determining the shape of the objects. See the notes for the valid options.
Returns:	emperor.Emperor Emperor object with updated settings.
Raises:	KeyError If `category` is not part of the metadata. TypeError If `category` is not a string. ValueError If `shapes` describes fewer or more categories than the ones present in the `category` column. If `shapes` has shapes in a non-string format.

category: str

Name of the metadata column.

shapes: dict or pd.Series, optional

Mapping of categories to string values determining the shape of the objects. See the notes for the valid options.

Returns:

emperor.Emperor

Emperor object with updated settings.

Raises:

KeyError

If category is not part of the metadata.

TypeError

If category is not a string.

ValueError

If shapes describes fewer or more categories than the ones present in the category column. If shapes has shapes in a non-string format.