emperor.Emperor.visibility_by¶

Emperor.visibility_by(category, visibilities=None, negate=False)¶

Set the visibility settings for the plot elements

Parameters:

Parameters:	category: str Name of the metadata column. visibilities: dict, list or pd.Series, optional When this argument is a `dict` or `pd.Series`, it is a mapping of categories to a boolean values determining whether or not that category should be visible. When this argument is a `list`, only categories present will be visible in the plot. negate: bool Whether or not to negate the values in `visibilities`.
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 `visibilities` describes fewer or more categories than the ones present in the `category` column. If `visibilities` has visibilities in a non-string format.

category: str

Name of the metadata column.

visibilities: dict, list or pd.Series, optional

When this argument is a dict or pd.Series, it is a mapping of categories to a boolean values determining whether or not that category should be visible. When this argument is a list, only categories present will be visible in the plot.

negate: bool

Whether or not to negate the values in visibilities.

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 visibilities describes fewer or more categories than the ones present in the category column. If visibilities has visibilities in a non-string format.