check_plate: Checks whether the input file is valid for use with the...

View source: R/check_plate.R

check_plateR Documentation

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

Description

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

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

Examples

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

check_plate(file = file_path)

tidyplate documentation built on Oct. 9, 2024, 1:07 a.m.