AllWells

AllWells[]⟹wells

generates a matrix of all of the wells in a microtiter plate.

AllWells[plate]⟹wells

generates all of the wells in the provided microtiter plate.

AllWells[vessel]⟹wells

returns a single well for the provided vessel.

AllWells[startWell,endWell]⟹wells

generates all of the wells in a microtiter plate from the startWell to the provided endWell.

AllWells[endWell]⟹wells

generates all of the wells in a microtiter plate up to the provided endWell.

Details

By default, a standard SBS 96-well microtiter is assumed, but options can be provided for alternative plate formats.

Input

Output

General Options

Messages

	BadOrder	Requested to generate a range of wells where the startWell `1` exceeds the position of the endWell `2`. Please change the inputs such that the initial well comes before the end well.
	MissingModel	The specified plate container `1` does not have a Model. Please ensure that `1` is valid by running ValidObjectQ with Verbose -> Failures.
	ModelMismatch	The specified plate model argument `1` does not match the plate model option `2`. Please note that if specifying a model both as an argument and an option, both these models must be the same object.
	ObjectModelMismatch	The specified plate container `1` has a model that does not match the specified model `2`. Please ensure that the model of `1` is the same as the specified model `2`.

Examples

Basic Examples (5)

If provided with a range of wells, the function gives all wells in the provided range:

If provided with only an end well, the function gives wells from the first well to the provided end well:

If provided with no input, the function gives a plate worth of wells:

If provided with a plate model, the function give a full plate worth of wells:

If provided with a plate object, this function gives a full plate worth of wells based on the plate's model:

Additional Examples (1)

Well inputs can be in any valid well form including implicitly typed well indexes:

Options (11)

AspectRatio (1)

An alternative aspect ratio can be directly provided to the function as an option as well:

InputFormat (1)

The InputFormat of the well's can be provided to the function for non-explicitly typed wells:

Model (1)

A plate model can be provided to AllWells to be used for determining the AspectRatio and NumberOfWells:

MultiplePlates (4)

The MultiplePlates option can be used to spesify how to hanle wells beyond a single plate and works as it does in ConvertWell:

For example, if MultiplePlates is set to Wrap, it will generate all positions from the start to the finish plate but drop the plate numbering from the position:

Alternatively, if MultiplePlates is told to Ingore the maximum position, it will roll past H12 in generating wells Top to 2B12:

Or MultiplePlates can be set to Split the oToput into a list of plate and position:

NumberOfWells (1)

The maximum NumberOfWells can be directly provided for the function as an option:

OutputFormat (1)

Any output format known to ConvertWell is a valid output format for AllWells:

PlateOrientation (2)

The PlateOrientation option can be used to control the sublisting of the oToput to either be in Landscape ("A1" in Topper left hand corner) or Portrait ("A1" in bottom left hand corner) form:

If None is requested for the PlateOrientation, a flat list of wells will be provided:

Attributes (5)

Listable (4)

The function is listable by wells:

The function is also listable when provided with a fixed starting well and two different ending wells, it will run the function on both combinations of start to end:

If provided with lists of both start and end wells of the same length, the function will MapThread over the start, end pairs:

If provided with lists of start and end wells of different lengths, the function will execute for each possible combination of start, end pairs:

SLLified (1)

The Function is SLLified to take plate model IDs and packets as arguments:

Messages (11)

AspectRatioConflict (4)

If a plate model is provided as input and its AspectRatio doesn't match what was provided, return an error:

If a plate model is provided as an option and its AspectRatio doesn't match what was provided as a separate option, return an error:

If a plate object is provided as an input and its AspectRatio doesn't match what was provided, return an error:

If a plate object is provided as an input and its AspectRatio doesn't match what was provided as a separate option, return an error:

BadOrder (1)

If a range is provided where the starting well's position exceeds the ending wells position, the BadOrder message will be thrown:

MissingModel (1)

If the plate object does not have its model specified, the MissingModel error will be thrown:

ModelMismatch (1)

If a plate model is provided as both an argument and an option, and they do not agree, the ModelMismatch error will be thrown:

NumberOfWellsConflict (3)

If a plate model is provided as input and its NumberOfWells doesn't match what was provided, return an error:

If a plate model is provided as an option and its AspectRatio doesn't match what was provided as a separate option, return an error:

If a plate object is provided as an input and its NumberOfWells doesn't match what was provided, return an error:

ObjectModelMismatch (1)

If a plate object is provided as an argument and its model does not match the model specified as an option, then the ObjectModelMismatch error will be thrown: