emperor.Emperor.animations_by

Emperor.animations_by(gradient, trajectory, colors, speed=1, radius=1)

Set the shape settings for the plot elements

Parameters:

gradient: str

Name of the metadata column that orders samples.

trajectory: str

Name of the metadata column that groups samples.

colors: dict or pd.Series

Mapping of trajectory categories to a CSS color attribute.

speed: float

How fast the animation should go.

radius: float

The radius of the animated traces.

Returns:

emperor.Emperor

Emperor object with updated settings.

Raises:

KeyError

If gradient or trajectory are not part of the metadata.

TypeError

If speed or radius are not numbers.

See also

emperor.core.Emperor.color_by, emperor.core.Emperor.scale_by, emperor.core.Emperor.shape_by, emperor.core.Emperor.opacity_by, emperor.core.Emperor.visibility_by, emperor.core.Emperor.set_background_color, emperor.core.Emperor.set_axes