ecl-logo Documentation
ECL`

LabelContainer

LabelContainer[Options]⟹UnitOperation

generates an ExperimentSamplePreparation/ExperimentCellPreparation-compatible UnitOperation that labels a container for use in other primitives.

    
LabelContainer purchases or selects existing user-owned containers and assigns them labels that can be used in other downstream unit operations.
    

Experimental Principles

    Figure 1.1: The LabelSample and LabelContainer unit operations will fulfill requests for samples/containers either by using an existing sample/container, purchasing a sample/container from the ECL inventory, transferring an existing sample into a new requested container, or by making the sample via ExperimentStockSolution. The fulfilled sample or container can then be used downstream by referring to its assigned label.

Experiment Options

    General

    Label

    The label of the samples that are to be prepared.
    Default Value: Null
    Pattern Description: A string or Null.
    Programmatic Pattern: _String
    Index Matches to: Label

    Restricted

    Indicates whether the container should be restricted from automatic use is any of your team's experiments that request the container's models. (Restricted can only be used in experiments when specifically provided as input to the experiment functions by a team member). Setting the option to Null means the sample should be untouched. Setting the option to True or False will set the Restricted field of the sample to that value respectively.
    Default Value: Null
    Pattern Description: True or False or Null.
    Programmatic Pattern: (Null | BooleanP) | Null
    Index Matches to: Label

    Container

    The container object that will be labeled for future use.
    Default Value: Null
    Pattern Description: An object of type or subtype Object[Container] or Model[Container] or a prepared sample or Null.
    Programmatic Pattern: (Null | (ObjectP[{Object[Container], Model[Container]}] | _String)) | Null
    Index Matches to: Label

    Preparation

    Indicates if this unit operation is carried out primarily robotically or manually. Manual unit operations are executed by a laboratory operator and robotic unit operations are executed by a liquid handling work cell.
    Default Value: Automatic
    Pattern Description: Manual or Robotic.
    Programmatic Pattern: PreparationMethodP | Automatic

Example Calls

    Basic Examples

    Request a new 50mL tube to use as the destination of a Transfer unit operation:
    Request a new 1L bottle and set it to restricted so that other protocols cannot automatically use it after our sample preparation is finished:

Preferred Input Containers

    LabelContainer can select any container in the ECL. However, when selecting a new container, it is recommended to use an ECL preferred container to maximize compatibility with other downstream unit operations.

Warnings and Errors

    Messages  (2)

    ObjectDoesNotExist  (2)

    Throw a message if we have a container that does not exist (ID form):

    Throw a message if we have a container that does not exist (name form):

Last modified on Thu 11 Sep 2025 09:52:09

EMERALD CLOUD LAB
15500 Wells Port Drive
Austin, TX 78728
© 2025 Emerald Cloud Lab, Inc.