R/plate_metadata.R

In rforbiochemists/wellr: Utilities for Working With Plate Based Data

#' Read a `{plater}` Formatted Metadata File
#'
#' @param file File path to a `{plater}` formatted `.csv` file which contains
#' metadata information.
#' @param sep The separator for the `.csv` file, defaults to ",".
#'
#' @return a tibble::tibble()
#' @export
#'
#' @examples
#'
#' file_meta <- system.file(
#'   "extdata",
#'   "20220929_1steptimer20_metainfo.csv",
#'   package = "wellr"
#' )
#'
#' plate_read_meta(file_meta)
plate_read_meta <- function(file, sep = ",") {
  plater::read_plate(file, well_ids_column = "well", sep = sep)
}

#' Add `{plater{` Formatted Metadata to a Dataset
#'
#' @param data A tibble::tibble() which contains a 'well' column, that will have
#' the metadata added to it.
#' @param file File patch to a `{plater}` formatted `.csv` file which contains
#' the metadat information.
#'
#' @return a tibble::tibble()
#' @export
#'
#' @examples
#' file_data <- system.file(
#'   "extdata",
#'   "20220929_1steptimer20.csv",
#'   package = "wellr"
#' )
#' file_meta <- system.file(
#'   "extdata",
#'   "20220929_1steptimer20_metainfo.csv",
#'   package = "wellr"
#' )
#'
#' plate_read_biotek(file_data) |>
#'   plate_add_meta(file_meta)
plate_add_meta <- function(data, file) {
  data |>
    dplyr::left_join(plate_read_meta(file), by = "well")
}