R/new-templates.R

In EricEdwardBryant/screenmill: Tools for working with ScreenMill data

# ---- New Strain Collection ----
#' Create new strain collection
#'
#' A convenience function to create a new strain collection keyfile
#'
#' @param id ID of new library. This ID needs to be unique in the database.
#' @param nplates Number of plates in the library.
#' @param format Size of plates. Defaults to 96.
#' @param dim Aspect ratio of rows to columns. Defaults to \code{c(2, 3)}.
#'
#' @export

new_strain_collection <- function(id, nplates, format = 96, dim = c(2, 3)) {
  nrow <- dim[1] * sqrt(format / prod(dim))
  ncol <- dim[2] * sqrt(format / prod(dim))
  LETTERS <- expand_letters(nrow, LETTERS)

  data_frame(
    strain_collection_id = id,
    strain_id = '',
    plate  = (1:nplates) %>% rep(each = format),
    row    = (LETTERS[1:(format / ncol)]) %>% rep(times = nplates, each = ncol),
    column = (1:(format / nrow)) %>% rep(length.out = format * nplates),
    plate_control = FALSE,
    strain_collection_notes  = '') %>%
    write.csv(file = paste0(id, '.csv'), row.names = FALSE)
}