Skip to contents

Checks whether the input file is valid for use with the tidy_plate() function

Source: R/check_plate.R
check_plate.Rd

check_plate() performs quality checks on the input microwell shaped data and warns the user if there is any discrepancy. The user can either fix the input file or use the build_plate() function to build a template csv or xlsx file.

Usage

check_plate(file, well_id = "well", sheet = 1)

Arguments

file

A character string containing the path to a csv or excel file.

well_id

A character string that will be the name for the well id column.

sheet

If file type is xlsx this is the sheet name (character) or number (integer).

Value

An message indicating whether the input file is compatible with the tidy_plate() function

See also

build_plate()

Examples

file_path <- system.file(
  "extdata",
  "example_12_well.xlsx",
  package = "tidyplate"
)

check_plate(file = file_path)
#> example_12_well.xlsx: OK; Plate type: 12-well