is_well_on_edge {maldipickr}

Identify the wells on the plate's edge

Description

Identify the wells on the plate's edge

Usage

is_well_on_edge(
  well_number,
  plate_layout = c(96, 384),
  edges = c("top", "bottom", "left", "right"),
  details = FALSE
)

Arguments

well_number

A vector of positive numeric well identifier

plate_layout

An integer indicating the maximum number of well on the plate

edges

A character vector pointing which plate edges should be considered

details

A logical controlling whether a data.frame with more details should be returned

Details

Flag the wells located on the edges of a 96- or 384-well plate, based on the following well numbering:

• Well numbers start at 1

• Well are numbered from left to right and then top to bottom of the plate.

Value

A logical vector, the same length as well_number indicating whether the well is on the edge. If details = TRUE, the function returns a data.frame that complements the logical vector with the well_number, row and column positions.

Examples

# Logical vector indicating whether the wells are on the four edges
is_well_on_edge(1:96, plate_layout = 96)
# More details can be obtained to verify the results
well_df <- is_well_on_edge(1:96, plate_layout = 96, details = TRUE)
# And the resulting prediction displayed
matrix(well_df$is_edge, ncol = max(well_df$col), byrow = TRUE)