Skip to contents

Build a csv or xlsx template for each plate type

Source: R/build_plate.R
build_plate.Rd

build_plate() helps the user build an empty csv or xlsx file that can be used as a template for storing plate data. Ensure that plate names are unique. Once populated it can be used as an input for tidy_plate() function.

Usage

build_plate(
  plate_type = 6,
  n_plates = 1,
  plate_names = NULL,
  file = NULL,
  file_type = NULL
)

Arguments

plate_type

A specific integer (6, 12, 24, 48, 96, 384, or 1536) indicating the type of microwell plate.

n_plates

A positive integer indicating the number of plates.

plate_names

A character vector of unique values that will be assigned to each plate. Its length should be equal to the value of n_plates.

file

A character string naming the file.

file_type

[Deprecated] A character string of the output file type. It can either be a csv or xlsx file. The default is csv.

Value

A csv or xlsx template file.

See also

tidy_plate(), generate_plate()

Examples

temp_file <- tempfile(fileext = ".csv")

build_plate(plate_type = 6, n_plates = 2, file = temp_file)