read_plate_layout: Read a plate layout file into a tibble

View source: R/read_plate_layout.R

read_plate_layoutR Documentation

Read a plate layout file into a tibble

Description

read_layout() reads a plate layout file (.csv, .txt, .xls, or .xlsx), and returns it as a formatted tibble. Variable types are guessed with readr::parse_guess(). The originally required "Type" column heading is now optional.

Usage

read_plate_layout(filepath, .empty_vals = c("Empty", "empty", NA))

Arguments

filepath

A complete file path, pointing to the plate layout file

.empty_vals

A vector containing all values which signify an empty well.

Value

Returns a tibble, mapping experimental variables to well positions. All outputs contain the columns: row, column, and well.

A single column is added containing the values for all user-defined variables, separated by '__'. If all experimental variables are defined in the layout, wells with identical entries in the "condition" column are technical replicates.

Column types for each variable (e.g. character, numeric) are guessed using readr::parse_guess().

Wells for which all variables contain one of the "empty well" values supplied to the argument .empty_vals are dropped from the layout.


taiawu/dsfworld_package documentation built on June 18, 2024, 5:39 a.m.