quicR (version 2.1.0)

plot_metrics: Plot metrics generated from the "calculate" family of quicR functions.

Description

Generates a faceted figure of boxplots.

Usage

plot_metrics(
  data,
  sample_col = "Sample IDs",
  fill = "Dilutions",
  dilution_bool = TRUE,
  nrow = 2,
  ncol = 2
)

Value

A ggplot object

Arguments

data

A dataframe containing the calculated metrics from the "calculate" family of quicR functions.

sample_col

The name of the column containing the sample IDs.

fill

The column containing the fill aesthetic. Usually the dilutions column.

dilution_bool

Logical; should dilution factors be included in the plot?

nrow

Integer; number of rows to output in the plot.

ncol

Integer; number of columns to output in the plot.

Examples

# This test takes >5 sec
# \donttest{
file <- system.file(
  "extdata/input_files",
  file = "test4.xlsx",
  package = "quicR"
)

data <- quicR::get_real(file)[[1]] |>
  quicR::normalize_RFU()

meta <- quicR::organize_tables(file) |>
  quicR::convert_tables()

calculate_metrics(data, meta) |>
  plot_metrics()
# }