- added snapshot test for df_to_array()

DESCRIPTION

@@ -1,7 +1,7 @@
 Package: serocalculator
 Type: Package
 Title: Estimating Infection Rates from Serological Data
-Version: 1.2.0.9003
+Version: 1.2.0.9004
 Authors@R: c(
   person(given = "Peter", family = "Teunis", email = "[email protected]", role = c("aut", "cph"), comment = "Author of the method and original code."),
   person(given = "Kristina", family = "Lai", email = "[email protected]", role = c("aut", "cre")), 

NEWS.md

@@ -1,5 +1,8 @@
 # serocalculator (development version)
 
+* created unit test for `df_to_array()`
+* fixed `dplyr::select()` deprecation warning in `df_to_array()`
+
 # serocalculator 1.2.0
 * Added `test-summary.pop_data` test
 

R/df_to_array.R

@@ -8,7 +8,7 @@
 #'
 #' @keywords internal
 #'
-df.to.array <- function(
+df.to.array <- function( # nolint: object_name_linter
     df,
     dim_var_names,
     value_var_name = "value") {
@@ -18,10 +18,14 @@ df.to.array <- function(
 
 #' Convert a data.frame (or tibble) into a multidimensional array
 #'
-#' @param df a [data.frame()] (or [tibble::tibble()]) in long format (each row contains one value for the intended array)
-#' @param dim_var_names a [character()] vector of variable names in `df`. All of these variables should be factors, or a warning will be produced.
-#' @param value_var_name a [character()] variable containing a variable name from `df` which contains the values for the intended array.
-#' @return an [array()] with dimensions defined by the variables in `df` listed in `dim_var_names`
+#' @param df a [data.frame()] (or [tibble::tibble()]) in long format
+#' (each row contains one value for the intended array)
+#' @param dim_var_names a [character()] vector of variable names in `df`.
+#' All of these variables should be factors, or a warning will be produced.
+#' @param value_var_name a [character()] variable containing a variable name
+#' from `df` which contains the values for the intended array.
+#' @return an [array()] with dimensions defined by the variables in `df`
+#' listed in `dim_var_names`
 #'
 #' @examples
 #' library(dplyr)
@@ -33,7 +37,9 @@ df.to.array <- function(
 #'     cols = c("Sepal.Length", "Sepal.Width", "Petal.Width", "Petal.Length")
 #'   ) %>%
 #'   mutate(parameter = factor(parameter, levels = unique(parameter)))
-#' arr <- df %>% serocalculator:::df.to.array(dim_var_names = c("parameter", "Species"))
+#' arr <- df %>%
+#'   serocalculator:::df_to_array(
+#'      dim_var_names = c("parameter", "Species"))
 #' ftable(arr[,,1:5])
 #' @noRd
 df_to_array <- function(
@@ -49,7 +55,7 @@ df_to_array <- function(
 
   all_factors <-
     df %>%
-    select(dim_var_names) %>%
+    select(all_of(dim_var_names)) %>%
     sapply(FUN = is.factor) %>%
     all()
 
@@ -77,6 +83,6 @@ df_to_array <- function(
     )
 
   df %>%
-    mutate(.by = all_of(dim_var_names), obs = 1:n()) %>%
+    mutate(.by = all_of(dim_var_names), obs = row_number()) %>%
     xtabs(formula = formula(xtabs_formula))
 }

tests/testthat/_snaps/df_to_array.md

@@ -0,0 +1,111 @@
+# df_to_array() produces consistent results
+
+    WAoAAAACAAQEAQACAwAAAAMOAAACWEAUZmZmZmZmQAwAAAAAAAA/yZmZmZmZmj/2ZmZmZmZm
+    QBwAAAAAAABACZmZmZmZmj/2ZmZmZmZmQBLMzMzMzM1AGTMzMzMzM0AKZmZmZmZmQAQAAAAA
+    AABAGAAAAAAAAEATmZmZmZmaQAgAAAAAAAA/yZmZmZmZmj/2ZmZmZmZmQBmZmZmZmZpACZmZ
+    mZmZmj/4AAAAAAAAQBIAAAAAAABAFzMzMzMzM0AFmZmZmZmaP/5mZmZmZmZAFGZmZmZmZkAS
+    zMzMzMzNQAmZmZmZmZo/yZmZmZmZmj/0zMzMzMzNQBuZmZmZmZpACMzMzMzMzT/4AAAAAAAA
+    QBOZmZmZmZpAHGZmZmZmZkAIAAAAAAAAQADMzMzMzM1AF5mZmZmZmkASZmZmZmZmQAjMzMzM
+    zM0/yZmZmZmZmj/4AAAAAAAAQBYAAAAAAABAAmZmZmZmZj/0zMzMzMzNQBAAAAAAAABAGTMz
+    MzMzM0AHMzMzMzMzP/zMzMzMzM1AFmZmZmZmZkAUAAAAAAAAQAzMzMzMzM0/yZmZmZmZmj/2
+    ZmZmZmZmQBoAAAAAAABABmZmZmZmZj/4AAAAAAAAQBJmZmZmZmZAGgAAAAAAAEAIAAAAAAAA
+    QAGZmZmZmZpAFzMzMzMzM0AVmZmZmZmaQA8zMzMzMzM/2ZmZmZmZmj/7MzMzMzMzQBbMzMzM
+    zM1ABmZmZmZmZj/0zMzMzMzNQBIAAAAAAABAHmZmZmZmZkAIAAAAAAAAQADMzMzMzM1AGmZm
+    ZmZmZkASZmZmZmZmQAszMzMzMzM/0zMzMzMzMz/2ZmZmZmZmQBkzMzMzMzNACmZmZmZmZj/5
+    mZmZmZmaQBLMzMzMzM1AE5mZmZmZmkAEAAAAAAAAP/szMzMzMzNAEgAAAAAAAEAUAAAAAAAA
+    QAszMzMzMzM/yZmZmZmZmj/4AAAAAAAAQBOZmZmZmZpAAzMzMzMzMz/wAAAAAAAAQApmZmZm
+    ZmZAHTMzMzMzM0AHMzMzMzMzP/zMzMzMzM1AGTMzMzMzM0ARmZmZmZmaQAczMzMzMzM/yZmZ
+    mZmZmj/2ZmZmZmZmQBpmZmZmZmZABzMzMzMzMz/0zMzMzMzNQBJmZmZmZmZAGszMzMzMzUAE
+    AAAAAAAAP/zMzMzMzM1AFzMzMzMzM0ATmZmZmZmaQAjMzMzMzM0/uZmZmZmZmj/4AAAAAAAA
+    QBTMzMzMzM1ABZmZmZmZmj/2ZmZmZmZmQA8zMzMzMzNAHMzMzMzMzUAMzMzMzMzNQAQAAAAA
+    AABAGGZmZmZmZkAVmZmZmZmaQA2ZmZmZmZo/yZmZmZmZmj/4AAAAAAAAQBQAAAAAAABAAAAA
+    AAAAAD/wAAAAAAAAQAwAAAAAAABAGgAAAAAAAEAJmZmZmZmaQAAAAAAAAABAFGZmZmZmZkAT
+    MzMzMzMzQAszMzMzMzM/yZmZmZmZmj/5mZmZmZmaQBeZmZmZmZpACAAAAAAAAD/4AAAAAAAA
+    QBDMzMzMzM1AGZmZmZmZmkAFmZmZmZmaP/5mZmZmZmZAFTMzMzMzM0ATMzMzMzMzQAgAAAAA
+    AAA/uZmZmZmZmj/2ZmZmZmZmQBgAAAAAAABAAZmZmZmZmj/wAAAAAAAAQBAAAAAAAABAGzMz
+    MzMzM0AIAAAAAAAAQADMzMzMzM1AFgAAAAAAAEARMzMzMzMzQAgAAAAAAAA/uZmZmZmZmj/x
+    mZmZmZmaQBhmZmZmZmZABzMzMzMzMz/2ZmZmZmZmQBLMzMzMzM1AFszMzMzMzUAEAAAAAAAA
+    QAAAAAAAAABAFAAAAAAAAEAXMzMzMzMzQBAAAAAAAAA/yZmZmZmZmj/zMzMzMzMzQBZmZmZm
+    ZmZABzMzMzMzMz/0zMzMzMzNQAzMzMzMzM1AFzMzMzMzM0AGZmZmZmZmQAMzMzMzMzNAFGZm
+    ZmZmZkAWzMzMzMzNQBGZmZmZmZo/2ZmZmZmZmj/4AAAAAAAAQBrMzMzMzM1ACMzMzMzMzT/2
+    ZmZmZmZmQBGZmZmZmZpAGZmZmZmZmkAJmZmZmZmaQAJmZmZmZmZAFTMzMzMzM0AVmZmZmZma
+    QA8zMzMzMzM/2ZmZmZmZmj/0zMzMzMzNQBZmZmZmZmZACAAAAAAAAD/4AAAAAAAAQBIAAAAA
+    AABAGgAAAAAAAEAIAAAAAAAAP/zMzMzMzM1AFgAAAAAAAEAUZmZmZmZmQAwAAAAAAAA/0zMz
+    MzMzMz/2ZmZmZmZmQBczMzMzMzNABZmZmZmZmj/wAAAAAAAAQBBmZmZmZmZAHszMzMzMzUAO
+    ZmZmZmZmQAGZmZmZmZpAGszMzMzMzUAWzMzMzMzNQA5mZmZmZmY/0zMzMzMzMz/7MzMzMzMz
+    QBjMzMzMzM1AAZmZmZmZmj/4AAAAAAAAQBIAAAAAAABAHszMzMzMzUAEzMzMzMzNQAJmZmZm
+    ZmZAG5mZmZmZmkAUZmZmZmZmQA5mZmZmZmY/0zMzMzMzMz/4AAAAAAAAQBZmZmZmZmZABAAA
+    AAAAAD/xmZmZmZmaQA8zMzMzMzNAGAAAAAAAAEABmZmZmZmaP/gAAAAAAABAFAAAAAAAAEAV
+    mZmZmZmaQAszMzMzMzM/yZmZmZmZmj/7MzMzMzMzQBeZmZmZmZpACZmZmZmZmj/8zMzMzMzN
+    QBMzMzMzMzNAG5mZmZmZmkAJmZmZmZmaQAJmZmZmZmZAFszMzMzMzUAUZmZmZmZmQA2ZmZmZ
+    mZo/2ZmZmZmZmj/4AAAAAAAAQBhmZmZmZmZABmZmZmZmZj/0zMzMzMzNQBAAAAAAAABAFmZm
+    ZmZmZkAGZmZmZmZmQAAAAAAAAABAE5mZmZmZmkASZmZmZmZmQAzMzMzMzM0/yZmZmZmZmj/w
+    AAAAAAAAQBkzMzMzMzNABAAAAAAAAD/4AAAAAAAAQBOZmZmZmZpAHszMzMzMzUAGZmZmZmZm
+    QAAAAAAAAABAGszMzMzMzUAUZmZmZmZmQApmZmZmZmY/4AAAAAAAAD/7MzMzMzMzQBhmZmZm
+    ZmZABmZmZmZmZj/zMzMzMzMzQBLMzMzMzM1AGTMzMzMzM0AFmZmZmZmaP/zMzMzMzM1AE5mZ
+    mZmZmkATMzMzMzMzQAszMzMzMzM/yZmZmZmZmj/+ZmZmZmZmQBmZmZmZmZpABzMzMzMzMz/0
+    zMzMzMzNQBEzMzMzMzNAGszMzMzMzUAKZmZmZmZmQADMzMzMzM1AFszMzMzMzUAUAAAAAAAA
+    QAgAAAAAAAA/yZmZmZmZmj/5mZmZmZmaQBpmZmZmZmZACAAAAAAAAD/2ZmZmZmZmQBGZmZmZ
+    mZpAHMzMzMzMzUAJmZmZmZmaP/zMzMzMzM1AGAAAAAAAAEAUAAAAAAAAQAszMzMzMzM/2ZmZ
+    mZmZmj/5mZmZmZmaQBszMzMzMzNABmZmZmZmZj/2ZmZmZmZmQBMzMzMzMzNAGMzMzMzMzUAG
+    ZmZmZmZmP/zMzMzMzM1AEzMzMzMzM0AUzMzMzMzNQAwAAAAAAAA/yZmZmZmZmj/4AAAAAAAA
+    QBrMzMzMzM1ACAAAAAAAAD/7MzMzMzMzQBQAAAAAAABAGGZmZmZmZkAIAAAAAAAAP/zMzMzM
+    zM1AE5mZmZmZmkAUzMzMzMzNQAszMzMzMzM/yZmZmZmZmj/2ZmZmZmZmQBgAAAAAAABABzMz
+    MzMzMz/4AAAAAAAAQBIAAAAAAABAGZmZmZmZmkAGZmZmZmZmQADMzMzMzM1AFmZmZmZmZkAS
+    zMzMzMzNQAmZmZmZmZo/yZmZmZmZmj/5mZmZmZmaQBbMzMzMzM1ABMzMzMzMzT/wAAAAAAAA
+    QAwAAAAAAABAHMzMzMzMzUAIAAAAAAAAP/mZmZmZmZpAFzMzMzMzM0ATMzMzMzMzQAjMzMzM
+    zM0/yZmZmZmZmj/5mZmZmZmaQBYAAAAAAABAAzMzMzMzMz/xmZmZmZmaQA5mZmZmZmZAHZmZ
+    mZmZmkAGZmZmZmZmP/5mZmZmZmZAGGZmZmZmZkAVmZmZmZmaQAszMzMzMzM/2ZmZmZmZmj/4
+    AAAAAAAAQBYAAAAAAABAAzMzMzMzMz/wAAAAAAAAQA2ZmZmZmZpAH5mZmZmZmkAOZmZmZmZm
+    QAAAAAAAAABAGZmZmZmZmkAUzMzMzMzNQBBmZmZmZmY/uZmZmZmZmj/4AAAAAAAAQBczMzMz
+    MzNABZmZmZmZmj/zMzMzMzMzQA8zMzMzMzNAGZmZmZmZmkAGZmZmZmZmQAGZmZmZmZpAFmZm
+    ZmZmZkAWAAAAAAAAQBDMzMzMzM0/yZmZmZmZmj/2ZmZmZmZmQBgAAAAAAABABZmZmZmZmj/5
+    mZmZmZmaQBRmZmZmZmZAGTMzMzMzM0AGZmZmZmZmP/gAAAAAAABAFGZmZmZmZkATmZmZmZma
+    QAjMzMzMzM0/yZmZmZmZmj/4AAAAAAAAQBWZmZmZmZpACAAAAAAAAD/4AAAAAAAAQBIAAAAA
+    AABAGGZmZmZmZkAEzMzMzMzNP/ZmZmZmZmZAFmZmZmZmZkAUAAAAAAAAQAmZmZmZmZo/yZmZ
+    mZmZmj/zMzMzMzMzQBgAAAAAAABACzMzMzMzMz/5mZmZmZmaQBIAAAAAAABAHszMzMzMzUAI
+    AAAAAAAAQAJmZmZmZmZAGGZmZmZmZkAWAAAAAAAAQAwAAAAAAAA/yZmZmZmZmj/0zMzMzMzN
+    QBrMzMzMzM1ACMzMzMzMzT/4AAAAAAAAQBLMzMzMzM1AGTMzMzMzM0ALMzMzMzMzQAMzMzMz
+    MzNAFmZmZmZmZkATmZmZmZmaQAzMzMzMzM0/uZmZmZmZmj/2ZmZmZmZmQBkzMzMzMzNAAmZm
+    ZmZmZj/0zMzMzMzNQBGZmZmZmZpAGZmZmZmZmkAIzMzMzMzNP/zMzMzMzM1AFgAAAAAAAEAR
+    mZmZmZmaQAgAAAAAAAA/yZmZmZmZmj/0zMzMzMzNQBZmZmZmZmZACAAAAAAAAD/0zMzMzMzN
+    QBBmZmZmZmZAGAAAAAAAAEAIAAAAAAAAP/zMzMzMzM1AEzMzMzMzM0AUZmZmZmZmQAszMzMz
+    MzM/yZmZmZmZmj/4AAAAAAAAQBYAAAAAAABABAAAAAAAAD/0zMzMzMzNQBAAAAAAAABAG5mZ
+    mZmZmkAIzMzMzMzNQADMzMzMzM1AFZmZmZmZmkAUAAAAAAAAQAwAAAAAAAA/0zMzMzMzMz/0
+    zMzMzMzNQBYAAAAAAABABMzMzMzMzT/zMzMzMzMzQBGZmZmZmZpAGszMzMzMzUAIzMzMzMzN
+    QAMzMzMzMzNAFmZmZmZmZkASAAAAAAAAQAJmZmZmZmY/0zMzMzMzMz/0zMzMzMzNQBhmZmZm
+    ZmZACAAAAAAAAD/2ZmZmZmZmQBJmZmZmZmZAG5mZmZmZmkAIzMzMzMzNQAJmZmZmZmZAFGZm
+    ZmZmZkARmZmZmZmaQAmZmZmZmZo/yZmZmZmZmj/0zMzMzMzNQBczMzMzMzNABMzMzMzMzT/z
+    MzMzMzMzQBAAAAAAAABAFzMzMzMzM0AFmZmZmZmaP/5mZmZmZmZAFGZmZmZmZkAUAAAAAAAA
+    QAwAAAAAAAA/4zMzMzMzMz/5mZmZmZmaQBQAAAAAAABAAmZmZmZmZj/wAAAAAAAAQApmZmZm
+    ZmZAGzMzMzMzM0AJmZmZmZmaQAJmZmZmZmZAF5mZmZmZmkAUZmZmZmZmQA5mZmZmZmY/2ZmZ
+    mZmZmj/+ZmZmZmZmQBZmZmZmZmZABZmZmZmZmj/0zMzMzMzNQBDMzMzMzM1AGszMzMzMzUAK
+    ZmZmZmZmQAQAAAAAAABAFszMzMzMzUATMzMzMzMzQAgAAAAAAAA/0zMzMzMzMz/2ZmZmZmZm
+    QBbMzMzMzM1ACAAAAAAAAD/zMzMzMzMzQBDMzMzMzM1AGszMzMzMzUAIAAAAAAAAQAJmZmZm
+    ZmZAFMzMzMzMzUAUZmZmZmZmQA5mZmZmZmY/yZmZmZmZmj/5mZmZmZmaQBbMzMzMzM1ABzMz
+    MzMzMz/0zMzMzMzNQBDMzMzMzM1AGTMzMzMzM0AEAAAAAAAAP/5mZmZmZmZAFAAAAAAAAEAS
+    ZmZmZmZmQAmZmZmZmZo/yZmZmZmZmj/2ZmZmZmZmQBjMzMzMzM1ABzMzMzMzMz/0zMzMzMzN
+    QBEzMzMzMzNAGgAAAAAAAEAIAAAAAAAAQAAAAAAAAABAFMzMzMzMzUAVMzMzMzMzQA2ZmZmZ
+    mZo/yZmZmZmZmj/4AAAAAAAAQBRmZmZmZmZABAAAAAAAAD/xmZmZmZmaQAgAAAAAAABAGMzM
+    zMzMzUALMzMzMzMzQAJmZmZmZmZAFZmZmZmZmkAUAAAAAAAAQApmZmZmZmY/yZmZmZmZmj/2
+    ZmZmZmZmQBbMzMzMzM1ABmZmZmZmZj/0zMzMzMzNQBBmZmZmZmZAF5mZmZmZmkAIAAAAAAAA
+    P/zMzMzMzM1AFGZmZmZmZgAABAIAAAABAAQACQAAAANkaW0AAAANAAAAAwAAAAQAAAADAAAA
+    MgAABAIAAAABAAQACQAAAAhkaW1uYW1lcwAAAhMAAAADAAAAEAAAAAQABAAJAAAADFNlcGFs
+    Lkxlbmd0aAAEAAkAAAALU2VwYWwuV2lkdGgABAAJAAAAC1BldGFsLldpZHRoAAQACQAAAAxQ
+    ZXRhbC5MZW5ndGgAAAAQAAAAAwAEAAkAAAAGc2V0b3NhAAQACQAAAAp2ZXJzaWNvbG9yAAQA
+    CQAAAAl2aXJnaW5pY2EAAAAQAAAAMgAEAAkAAAABMQAEAAkAAAABMgAEAAkAAAABMwAEAAkA
+    AAABNAAEAAkAAAABNQAEAAkAAAABNgAEAAkAAAABNwAEAAkAAAABOAAEAAkAAAABOQAEAAkA
+    AAACMTAABAAJAAAAAjExAAQACQAAAAIxMgAEAAkAAAACMTMABAAJAAAAAjE0AAQACQAAAAIx
+    NQAEAAkAAAACMTYABAAJAAAAAjE3AAQACQAAAAIxOAAEAAkAAAACMTkABAAJAAAAAjIwAAQA
+    CQAAAAIyMQAEAAkAAAACMjIABAAJAAAAAjIzAAQACQAAAAIyNAAEAAkAAAACMjUABAAJAAAA
+    AjI2AAQACQAAAAIyNwAEAAkAAAACMjgABAAJAAAAAjI5AAQACQAAAAIzMAAEAAkAAAACMzEA
+    BAAJAAAAAjMyAAQACQAAAAIzMwAEAAkAAAACMzQABAAJAAAAAjM1AAQACQAAAAIzNgAEAAkA
+    AAACMzcABAAJAAAAAjM4AAQACQAAAAIzOQAEAAkAAAACNDAABAAJAAAAAjQxAAQACQAAAAI0
+    MgAEAAkAAAACNDMABAAJAAAAAjQ0AAQACQAAAAI0NQAEAAkAAAACNDYABAAJAAAAAjQ3AAQA
+    CQAAAAI0OAAEAAkAAAACNDkABAAJAAAAAjUwAAAEAgAAAAEABAAJAAAABW5hbWVzAAAAEAAA
+    AAMABAAJAAAACXBhcmFtZXRlcgAEAAkAAAAHU3BlY2llcwAEAAkAAAADb2JzAAAA/gAABAIA
+    AAABAAQACQAAAAVjbGFzcwAAABAAAAACAAQACQAAAAV4dGFicwAEAAkAAAAFdGFibGUAAAQC
+    AAAAAQAEAAkAAAAEY2FsbAAAAAYAAAABAAQACQAAAAV4dGFicwAABAIAAAABAAQACQAAAAdm
+    b3JtdWxhAAAABgAAB/8AAAACAAAAAQAEAAkAAAANeHRhYnNfZm9ybXVsYQAAAP4AAAQCAAAA
+    AQAEAAkAAAAEZGF0YQAAAAEABAAJAAAAAS4AAAD+AAAA/g==
+

tests/testthat/test-df_to_array.R

@@ -0,0 +1,18 @@
+test_that("df_to_array() produces consistent results", {
+  library(dplyr)
+  library(tidyr)
+  df <- iris %>%
+    tidyr::pivot_longer(
+      names_to = "parameter",
+      cols = c(
+        "Sepal.Length",
+        "Sepal.Width",
+        "Petal.Width",
+        "Petal.Length"
+      )
+    ) %>%
+    mutate(parameter = factor(parameter, levels = unique(parameter)))
+  arr <- df %>%
+    serocalculator:::df_to_array(dim_var_names = c("parameter", "Species"))
+  arr %>% expect_snapshot_value(style = "serialize")
+})