convert_platemap: convert_platemap

In OxfordCMS/OCMSutility: Utility functions for OCMS

convert_platemap

Description

function to convert excel plate map to long data frame with map locations. uses readxl to read in excel file so additional arguments are passed to readxl::read_excel

Usage

convert_platemap(
  from_file = TRUE,
  plate_map,
  sheet = NULL,
  map_range,
  drop_empty = TRUE,
  ...
)

Arguments

from_file	logical. Set to TRUE if supplying platemap from excel file. Set to FALSE if supplying a data.frame. Default TRUE.
plate_map	excel file containing plate map
sheet	name or number of excel sheet. defaults to first sheet
map_range	string. cell range containing plate map format using excel notation (e.g. 'A1:H12')
drop_empty	boolean. default TRUE. drop unlabeled wells
...	Arguments passed to readxl::read_excel

Details

When from_file=FALSE, plate rows (e.g. A, B, C etc.) are set as rownames.

Value

datafame of platemap in long form

OxfordCMS/OCMSutility documentation built on Feb. 27, 2025, 8:19 p.m.