optimize_multi_plate_design {designit}

Convenience wrapper to optimize a typical multi-plate design

Description

The batch container will in the end contain the updated experimental layout

Usage

optimize_multi_plate_design(
  batch_container,
  across_plates_variables = NULL,
  within_plate_variables = NULL,
  plate = "plate",
  row = "row",
  column = "column",
  n_shuffle = 1,
  max_iter = 1000,
  quiet = FALSE
)

Arguments

batch_container

Batch container (bc) with all columns that denote plate related information

across_plates_variables

Vector with bc column name(s) that denote(s) groups/conditions to be balanced across plates, sorted by relative importance of the factors

within_plate_variables

Vector with bc column name(s) that denote(s) groups/conditions to be spaced out within each plate, sorted by relative importance of the factors

plate

Name of the bc column that holds the plate identifier

row

Name of the bc column that holds the plate row number (integer values starting at 1)

column

Name of the bc column that holds the plate column number (integer values starting at 1)

n_shuffle

Vector of length 1 or larger, defining how many random sample swaps should be performed in each iteration. See optimize_design().

max_iter

Stop any of the optimization runs after this maximum number of iterations. See optimize_design().

quiet

If TRUE, suppress informative messages.

Value

A list with named traces, one for each optimization step