add_plate: Read a plater-formatted file and combine it with an existing...

In ropenscilabs/plater: Read, Tidy, and Display Data from Microtiter Plates

Read a plater-formatted file and combine it with an existing data frame.

Description

Converts data from plater format to a data frame with one well per row and merges it into an existing data frame by well name.

Usage

add_plate(data, file, well_ids_column, sep = ",")

Arguments

data	The data frame to merge the file into. Must contain a column with well names.
file	The path of a .csv file formatted as described in read_plate.
well_ids_column	The name of the column in data containing the well IDs.
sep	The character used to separate columns in the file (e.g. "," or ";") Defaults to ",".

Details

If data contains more wells than in file, NA will be added to the merged column(s) for those wells. If the file contains more wells than data, those wells will be added to the bottom of the result with NA for the columns in data.

Value

Returns data as a tibble with as many new columns as plates in file. Empty wells are indicated with NA.

Examples

# Part of the data is tidy
file <- system.file("extdata", "example-2-part-A.csv", package = "plater")
data <- read.csv(file)

# Part of the data is plate-shaped
plate_shaped <- system.file("extdata", "example-2-part-B.csv", package = "plater")

# Combine the two
data <- add_plate(
   data = data, 
   file = plate_shaped,
   well_ids_column = "Wells")

# Now data are tidy
head(data)

ropenscilabs/plater documentation built on Oct. 29, 2024, 4:07 a.m.