Pr240 (#242)

* feat(add_correlated_data): warn if addCorGen `idname` is not unique

* Minor edit before merging

---------

Co-authored-by: mutlusun <mutlusun@users.noreply.github.com>
Co-authored-by: Keith Goldfeld <KSG@180MADPHMLT162.local>

Author: 3 people

R/add_correlated_data.R

@@ -59,7 +59,18 @@
 #' @export
 addCorData <- function(dtOld, idname, mu, sigma, corMatrix = NULL,
                        rho, corstr = "ind", cnames = NULL) {
+  # addCorData will produce odd results if `idname` appears multiple times in
+  # `dtOld`. Thus, we check and omit a warning.
+  
+  if (length(unique(dtOld[, get(idname)])) != nrow(dtOld)) {
+    valueWarning(
+      names = c("dtOld"),
+      msg = paste(idname, "appears multiple times in data table. Please check results.")
+    )
+  }
+
   # dtName must contain id for now
+  
   dtTemp <- copy(dtOld)
   data.table::setkeyv(dtTemp, idname)
 

tests/testthat/test-generate_correlated_data.R

@@ -398,6 +398,22 @@ test_that("genCorMat generates errors correctly.", {
 
 # addCorData ----
 
+test_that("addCorData emits warning if `idname` appears multiple times", {
+  tdef <- defData(varname = "grp", dist = "binary", formula = 0.5, id = "id")
+
+  dt <- genData(500, tdef)
+  dt <- rbind(dt, dt)
+
+  mu <- rnorm(3, mean = c(3, 8, 15))
+  sigma <- rgamma(3, 1.5, 1)
+  corMat <- genCorMat(3)
+
+  expect_warning(
+    addCorData(dt, "id", mu = mu, sigma = sigma, corMat = corMat),
+    "id appears multiple times in data table. Please check results."
+  )
+})
+
 test_that("addCorData adds correlated data with compound symmetry structure", {
 
   skip_on_cran()