init: Initialize Worklist & set defaults

View source: R/base.R

initR Documentation

Initialize Worklist & set defaults

Description

Initialization. Generates object gwl in .GlobalEnv

Usage

init(
  filename = paste0(format(Sys.time(), "%y%m%d"), "_gwl"),
  RackLabel = "trough200_1_frt",
  RackID = "",
  RackType = "",
  Position = 0,
  TubeID = "",
  Volume = 0,
  LiquidClass = "",
  TipMask = 0,
  ForcedRackType = "",
  MinDetectedVolume = "",
  Wash = "W",
  WTtemplate = "basic"
)

Arguments

filename

string, the name of the generated worklist and worktable (+ "_worktable.txt")

RackLabel

Max. 32 characters User-defined label (name) which is assigned to the labware.

RackID

Max. 32 characters, Labware barcode.

RackType

Max. 32 characters, Labware type (configuration name), e.g. “384 Well, landscape”.

Position

1 .. number of wells, Well position in the labware. The position starts with 1 and increases from rear to front and left to right.

TubeID

Max. 32 characters, Tube barcode.

Volume

0 .. +7158278, Pipetting volume in µl.

LiquidClass

Max. 32 characters, This optional parameter overwrites the liquid class specified in the Worklist command.

TipMask

1 .. 128, This optional parameter specifies the tip you want to use. The tip number is bit-coded, i.e. Tip 1 = 1, Tip 2 = 2, Tip 3 = 4; Tip 4 = 8 and so on. Please note that you can only use a tip which has been enabled with Tip Selection in the Worklist command. If you do not specify TipMask, Freedom EVOware uses one of the tips specified with Tip Selection in the Worklist command.

ForcedRackType

Max. 32 characters, This optional parameter is the configuration name of the labware. If specified, it is used instead of the labware type which is found on the Freedom EVOware worktable.

MinDetectedVolume

0 .. +7158278 Liquid volume in µl. If this optional parameter is specified and Liquid Level Detection is enabled in the selected liquid class, it is used by the LiHa to determine the minimum liquid height which must be available in the well. Otherwise a liquid detection error (not enough liquid) will be triggered. MinDetectedVolume specifies the usable volume of liquid. If the aspiration position in the liquid class specifies tip immersion (tip submerging), the actual liquid height in the well must be higher to allow immersion (i.e. the volume of liquid in the well must be more than MinDetectedVolume).

Wash

Default wash step to use

WTtemplate

character, data.frame or NULL. character: worktable template to load ("basic" only atm), data.frame: a worktable layout as a data.frame, NULL: an empty worktable.

Output

invisible(gwl), also saves object gwl to .GlobalEnv

See Also

Other general methods: addToWorklist(), addToWorktable(), write.gwl()


dcangst/rrobot documentation built on April 10, 2024, 1:59 a.m.