ConvertWell

ConvertWell[well]⟹formatted

converts to and from well indexes and well positions.

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

	AspectRatioConflict	The aspect ratio of the provided model `1` (`2`) does not agree with the provided AspectRatio (`3`). Please ensure that the AspectRatio you are specifying agrees with the AspectRatio of the Model plate you are specifying.
	BadRatio	The AspectRatio `1` and the NumberOfWells `2` would lead to an irregular shaped plate (not rectangular). Please ensure that Sqrt[NumberOfWells*AspectRatio] and Sqrt[NumberOfWells/AspectRatio] are integers.
	InputFormatConflict	The provided InputFormat `1` did not match the input format that was resolved from the input wells `2`. Please ensure that the input well is specified in such away that matches the InputFormat option.
	JoinedIndex	MultiplePlates is set to Joined but OutputFormat was specified as or resolved to `1`. Please note that if MultiplePlates is set to Joined, OutputFormat must be set to Position.
	NumberOfWellsConflict	The number of wells of the provided model `1` (`2`) does not agree with the provided NumberOfWells (`3`). Please ensure that the NumberOfWells you are specifying agrees with the NumberOfWells of the Model plate you are specifying.
	Strict	When MultiplePlates is set to Strict, the input well must not exceed the maximum NumberOfWells. Please set MultiplePlates to another option besides Strict, or change the input so as not to exceed NumberOfWells.

Examples

Basic Examples (3)

Convert a well position into a well index:

Convert a well index into a well position:

Convert from one well index format to another:

Additional Examples (9)

Position denotes wells as Letter-Digit strings (eg A1, C12, H4). They ascend Left to Right, then Top to Bottom:

Index dontes wells as digits. They ascend Left to Right, then Top to Bottom:

SerpentineIndex format denotes wells as digits. They ascend in alternating Left to Right and Right to Left patterns, but maintain the Top to Bottom order. For exmaple:

StaggeredIndex format denotes wells as digits. They ascend every other well in a row, but once they reach the end of a row they return to the beginning of the row to do even numbered wells. After that, they move to the next row:

TransposedIndex format denotes wells as digits. They ascend in alternating Left to Right and Right to Left patterns:

TransposedSerpentineIndex denotes wells as digits. They ascend in alternating Top to Bottom and Bottom to Top patterns:

TransposedStaggeredIndex format denotes wells in the Digit format. They ascend every other well in a column, but once they reach the end of a column they return to the beginning of the column to do even numbered wells. After that, they move to the next column:

RowColumnIndex format denotes wells in the {Digit,Digit} format (eg A1=={1,1},H12=={8,12}). The first digit is the row, and the second is the column. They ascend Left to Right then Top to Bottom:

If given an empty list, returns an empty list:

Options (7)

AspectRatio (1)

Convert the well assuming the plate has the specified AspectRatio. Often ought to be specified with NumberOfWells:

InputFormat (1)

The input format can be provided via the InputFormat option:

Model (1)

If Model is specified, convert the well using the AspectRatio and NumberOfWells present in that model:

MultiplePlates (2)

If MultiplePlates is left on Automatic and converting to positions, if the well's position exceeds the NumberOfWells, Joined is assumed:

If MultiplePlates is left on Automatic and converting to indexes, if the well's position exceeds the NumberOfWells, Split is assumed:

NumberOfWells (1)

Convert the well assuming the plate has the specified NumberOfWells:

OutputFormat (1)

The desired output format can be provided as well:

Attributes (1)

Listable (1)

The function is listable by wells:

Messages (7)

AspectRatioConflict (1)

When the model's information regarding AspectRatio conflicts with the given options, the AspectRatioConflict error is thrown:

BadRatio (2)

If the provided AspectRatio and NumberOfWells would lead to a non-rectangular plate, the BadRatio message is thrown:

InputFormatConflict (1)

If InputFormat is specified but does not agree with the input well format, return an error:

JoinedIndex (1)

If MultiplePlates is set to Joined, OutputFormat should be Position; otherwise a warning is thrown:

NumberOfWellsConflict (1)

When the model's information regarding NumberOfWells conflicts with the given options, the NumberOfWellsConflict error is thrown:

Strict (1)

If MultiplePlates is set to Strict, the inputted well must not exceed the maximum NumberOfWells:

Possible Issues (3)

A list of two integers will assume the input is a list of two separate wells if InputFormat is specified as Index, TransposedIndex, SerpentineIndex, StaggeredIndex, TransposedSerpentineIndex, or TransposedStaggeredIndex:

A list of two integers will assume the input is an ordered pair if InputFormat is specified as RowColumnIndex:

A list of two integers will assume the input is an ordered pair if InputFormat is not specified at all: