randomize_headrows: Randomize Headrow Trays

Description Usage Arguments Details Value

View source: R/randomize_headrows.R

Description

Randomize Headrow Trays

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
randomize_headrows(
  ents,
  nreps = 1,
  tray_cells = 80,
  tray_rows = 4,
  start_cell = 1,
  randomize_first = TRUE,
  checks = list("CHECK", 40),
  seed = NA
)

Arguments

ents

Vector listing names of entries to include in the experiment

nreps

Integer specifying the number of replications (i.e. full blocks)

tray_cells

Integer specifying the number of cells contained by each headrow tray

tray_rows

Integer specifying the number of rows per range. Note that this "rows" is shorthand for headrows, so this might more intuitively be thought of as columns.

start_cell

Integer specifying the starting number for the first cell

randomize_first

Logical indicating whether or not to randomize the first replication

checks

A list with two elements:

  1. A string or character vector listing the names of check(s) to include

  2. An integer specifying how often to repeat the checks

seed

Integer to seed the random number generator. Default NA value will not seed the random number generator.

Details

The headrows will be returned with randomized replications of experimental entries occuring one after another, with check entries inserted at regular intervals. Note that this returns a linear arrangement of trays with global range values increasing to infinity (i.e., the headrow trays are not wrapped at the length of the experiment field). Checks are first inserted at the beginning (i.e. tray 1, range 1, row 1), and then repeated at the specified number of cells. As noted above, the somewhat unfortunate nomenclature of headrows means that what would intuitively be thought of as "rows" are labeled "ranges", and what would intuitively be thought of as "columns" are labeled "rows".

Value

A dataframe containing the randomized headrows and all pertinent identifying information


etnite/bwardr documentation built on April 14, 2021, 7:04 p.m.