hit_grid: Plots multiple platemaps with and identifies hits

Description Usage Arguments Value Examples

View source: R/hit_grid.R

Description

Converts numerical values and well labels into 'hits' in the form of multiple plate maps. Hits are calculated as wells above or below a specified number of standard deviations from the overall average

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
hit_grid(
  data,
  well,
  plate_id,
  threshold = 2,
  ncols = 2,
  plate = 96,
  each = FALSE,
  scale_each = FALSE,
  palette = "Spectral",
  ...
)

Arguments

data

Numerical values to be scaled and plotted

well

Vector of well identifiers. e.g "A01"

plate_id

Vector of plate identifiers e.g "Plate_1"

threshold

Numerical value of standard deviations from the mean for a well to be classified as a 'hit'. Default it +/- 2 SD

ncols

Number of columns in the grid of plates

plate

Number of wells in the complete plates (96, 384 or 1536)

each

boolean, allowed for backwards compatibility, scale_each is now the preferred argument name

scale_each

boolean, if true scales each plate individually, if false will scale the pooled values of data

palette

RColorBrewer palette

...

additional arguments for plot wrappers

Value

ggplot plot

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
df01 <- data.frame(well = num_to_well(1:96),
  vals = rnorm(96),
  plate = 1)

df02 <- data.frame(well = num_to_well(1:96),
  vals = rnorm(96),
  plate = 2)

df <- rbind(df01, df02)

hit_grid(data = df$vals,
    well = df$well,
    plate_id = df$plate,
    plate = 96,
    each = FALSE)

Example output

Warning message:
In hit_grid(data = df$vals, well = df$well, plate_id = df$plate,  :
  argument 'each' has been deprecated, you should use 'scale_each' in the future

platetools documentation built on June 3, 2021, 5:06 p.m.