BMG_format: Format Table for BMG Sample ID Import

View source: R/BMG_format.R

BMG_formatR Documentation

Format Table for BMG Sample ID Import

Description

BMG_format accepts a plate layout .CSV file and formats the Sample IDs into a format which can be easily imported into the BMG control software.

Usage

BMG_format(
  file,
  save_path = "",
  save_name = "formatted.txt",
  write_file = FALSE
)

Arguments

file

A .CSV file containing the plate layout of Sample IDs.

save_path

The path to the directory that you want the file saved.

save_name

The name of the output file. Should have the ".txt" extension.

write_file

Logical. If true, function will write a .txt file; otherwise it will return a character vector.

Value

A text file containing information for import into the BMG control software.

Examples

layout_file <- system.file(
  "extdata/BMG_formatting",
  file = "plate_layout.csv",
  package = "quicR"
)
BMG_format(layout_file)


quicR documentation built on April 3, 2025, 11:20 p.m.