plateview_plot: Make a Plate-view plot

Description Usage Arguments Value

View source: R/plateview_plot.R

Description

Makes a plot that mimics looking down at a well plate. Wells are colored based on a user-defined column from a layout.

Usage

1
2
3
4
5
6
7
8
9
plateview_plot(
  plate_data,
  fill_col,
  title_var,
  shape = 22,
  size = 4,
  title_prefix = Sys.Date(),
  ...
)

Arguments

plate_data

a layout tibble (as created by dsfworld::read_plate_layout()), containing columns for plate row (called "row"), plate column (called "column"), and one variable by which the plate will be colored

fill_col

the column in the input layout by which to color in the wells in the plot

title_var

the column for which the plot will be named. Shuldn't be an argument in the future; I struggled with tidyeval here so just put it at as different variable... Gets sent to glue::glue(). See make_all_plots function for the origin of this issue, with !!sym(x) working for the fill_col argument, but un-passable to glue.

shape

the shape of the points used to make the wells. Defaults to 22 (filled square).

size

the shape of the points used to make the wells. Defaults to 4.

title_prefix

a prefix to be added to the title. Functionally, this can remain the same while title_var changes, to create consistent names when mapping over many variables. Also hopefully only a temporary argument, to be fixed in later versions.

...

to be passed to the ggplot2 aesetheics inside this function. Not actually used inside the function yet... another place to improve things here in the near furture.

Value

a plate-view plot, with wells colored based on the information on that well in the user-defined variable given in .fill_var.


taiawu/echowritr documentation built on Dec. 23, 2021, 7:42 a.m.