better name for the function format_wells

Author: douwe

R/wells.R

@@ -1,14 +1,14 @@
-#' Standardize a vector with well names.
+#' Normalize a vector with well names.
 #'
 #' @param v A vector with potentially sloppy well names
 #' @param format A single element character or numeric vector with the format of the plate
 #' @return A vector with standardized well names
 #' @export
 #' @examples
-#' format_wells(c("a01", "A 2", "0", " A 4 ", "A05", "H012"), 96)
+#' normalize_wells(c("a01", "A 2", "0", " A 4 ", "A05", "H012"), 96)
 #'
 #'
-format_wells <- function(v, format) {
+normalize_wells <- function(v, format) {
   v <- as.character(v) |>
     stringr::str_remove_all(" ") |>
     stringr::str_to_upper() |>

tests/testthat/test-wells.R

@@ -1,13 +1,13 @@
-test_that("function format_wells", {
+test_that("function normalize_wells", {
   wells1 <- c("A1", "B2", "c3", "0", "0")
   expect1 <- c("A1", "B2", "C3", NA, NA)
-  expect_equal(format_wells(wells1, 96), expect1)
+  expect_equal(normalize_wells(wells1, 96), expect1)
   wells2 <- c(0, 0)
   expect2 <- as.character(c(NA, NA))
-  expect_equal(format_wells(wells2, 96), expect2)
+  expect_equal(normalize_wells(wells2, 96), expect2)
   wells3 <- c("A01", " B02", "c03 ", " d0100", "E 50")
   expect3 <- c("A1", "B2", "C3", NA, NA)
-  expect_equal(format_wells(wells3, 96), expect3)
+  expect_equal(normalize_wells(wells3, 96), expect3)
 })
 
 test_that("Function check_wells works", {