pyplate.RecipeStep

class RecipeStep(recipe: Recipe, operator: str, frm: Container | PlateSlicer | Plate, to: Container | PlateSlicer | Plate, *operands)[source]

Bases: object

Stores information about a single step in a recipe.

Notes: The contents of this class are not meant to be consumed directly by users. Information about the step can be extracted using the dataframe and _repr_html_ methods. If a step is displayed in IPython (Jupyter), _repr_html_ will be called automatically.

__init__(recipe: Recipe, operator: str, frm: Container | PlateSlicer | Plate, to: Container | PlateSlicer | Plate, *operands)[source]

Creates a new RecipeStep.

Methods

__init__(recipe, operator, frm, to, *operands)

Creates a new RecipeStep.

dataframe([data_source, substance, mode, ...])

param data_source:

Where to get data from. 'source' or 'destination'.
dataframe(data_source: str = 'destination', substance: str | Substance = 'all', mode: str = 'final', container_mode: str = 'data', unit: str | None = None) → DataFrame[source]
Parameters:

  • data_source – Where to get data from. ‘source’ or ‘destination’.

  • substance – Substance or ‘all’ to display.

  • mode – ‘final’ to display final state, ‘delta’ to display change.

  • container_mode – ‘info’ for information about the container, ‘data’ for a dataframe of the container.

  • unit – unit to display volumes in. Defaults to config.volume_display_unit.

Returns: Dataframe of quantities in each well or the container.

If the designated ‘data_source’ is a Container, ‘container_mode’ will designate what is returned.

If ‘info’ is selected for ‘container_mode’, an informational representation of the final state of the Container will be returned. The ‘substance’, ‘mode’, and ‘unit’ arguments are ignored.

If ‘data’ is selected, a dataframe with one row and column will be returned.