fix bug reporting multiple obs for 2 panel factors

Author: kwstat

DESCRIPTION

@@ -1,7 +1,7 @@
 Type: Package
 Package: desplot
 Title: Plotting Field Plans for Agricultural Experiments
-Version: 1.10
+Version: 1.11
 Authors@R: 
     person("Kevin", "Wright", , "kw.stat@gmail.com", role = c("aut", "cre", "cph"),
            comment = c(ORCID = "0000-0002-0617-8673"))

NEWS.md

@@ -1,22 +1,30 @@
-# desplot 1.11 - unpublished
+# desplot 1.11 ()
 
 * Switch to MIT license.
 
+* Documentation pages now created via Github Actions.
+
+* Fix the checking for multiple cell values when there are 2 panel factors.
+
+
 # desplot 1.10 (2023-03-01)
 
 * One-row panels no longer have whitespace. Issue #9.
+
 * Replace `aes_string(x=x.string)` with `aes(x=.data[[x.string]])` etc.
 
 
 # desplot 1.9 (2021-10-30)
 
 * Tweaks to `ggdesplot` output.
+
 * Remove LazyData from DESCRIPTION.
 
 
 # desplot 1.8 (2020-10-21)
 
 * Bug fix for `dq` with multiple panels.
+
 * Use `inherits` to check class #4.
 
 

R/desplot.R

@@ -490,13 +490,21 @@ desplot <- function(data,
   fac2num <- function(x) as.numeric(levels(x))[x]
   if(is.factor(data[[x.string]])) data[[x.string]] <- fac2num(data[[x.string]])
   if(is.factor(data[[y.string]])) data[[y.string]] <- fac2num(data[[y.string]])
-  data <- .addLevels(data, x.string, y.string, panel.string)
+  #data <- .addLevels(data, x.string, y.string, panel.string)
 
-  # Check for multiple values
-  if(is.null(panel.string)){
+  # Check for multiple values for each cell.
+  if(is.null(ff$cond)) {
+    # no factor for panels
     tt <- table(data[[x.string]], data[[y.string]])
+  } else if(length(ff$cond) == 1L) {
+    # one conditioning factor
+    tt <- table(data[[x.string]], data[[y.string]], data[[ff$cond[1]]])
+  } else if(length(ff$cond)==2L) {
+    # two conditioning factors
+    tt <- table(data[[x.string]], data[[y.string]], data[[ff$cond[1]]], data[[ff$cond[2]]])
   } else {
-    tt <- table(data[[x.string]], data[[y.string]], data[[panel.string]])
+    message("Not checking for multiple data for each x/y/panel combination")
+    tt <- NULL
   }
   if(any(tt>1))
     warning("There are multiple data for each x/y/panel combination")

tests/testthat/test_desplot.R

@@ -41,7 +41,7 @@ test_that("num,col,text", {
   })
 })
 
-test_that("function `cleanup` checks variables", {
+test_that("function cleanup checks variables", {
   expect_error( desplot(oats35, yield~col+row, num=junk) )
   expect_error( desplot(oats35, yield~col+row, col=junk) )
   expect_error( desplot(oats35, yield~col+row, text=junk) )
@@ -134,6 +134,30 @@ test_that("subset", {
   })
 })
 
+## ---------------------------------------------------------------------------
+
+test_that("If a cell has multiple observations, issue a warning.",{
+  # No panel factor
+  dat0 <- expand.grid(col=1:2, row=1:2)
+  dat0$y <- rnorm(nrow(dat0))
+  dat0 <- rbind(dat0, dat0[1,]) # Create one cell that has 2 observations
+
+  # One panel factor
+  dat1 <- expand.grid(state=c("S1","S2"), col=1:2, row=1:2)
+  dat1$y <- rnorm(nrow(dat1))
+  dat1 <- rbind(dat1, dat1[1,]) # Create one cell that has 2 observations
+
+  # Two panel factors
+  dat2 <- expand.grid(state=c("S1","S2"), loc=c("L1","L2","L3"), col=1:2, row=1:2)
+  dat2$y <- rnorm(nrow(dat2))
+  dat2 <- rbind(dat2, dat2[1,]) # Create one cell that has 2 observations
+  
+  expect_warning( desplot(dat0, y~col*row) )
+  expect_warning( desplot(dat1, y~col*row|state) )
+  expect_warning( desplot(dat2, y~col*row|state*loc) )
+})
+
+
 # ----------------------------------------------------------------------------
 
 

vignettes/desplot_examples.Rmd

@@ -53,6 +53,23 @@ Note the largest positive/negative residuals are adjacent to each other,
 perhaps caused by the original data values being swapped.  Checking with
 experiment investigators (managers, data collectors, etc.) is recommended.
 
+# Infrequently asked questions
 
+## How do I change the ordering of panels?
+
+Make sure that the panel variable is a factor and then change the levels of the factor.
+
+In the example below, the first three panels are set to the levels C1, C3, C5. The other levels remain in the same (relative) order.
+
+```{r panelorder, eval=FALSE}
+library(agridat)
+library(desplot)
+data(besag.met)
+desplot(besag.met, yield~col*row|county, main="default county ordering")
+library(forcats)
+besag.met <- transform(besag.met,
+                       county=fct_relevel(county, c("C1","C3","C5")))
+desplot(besag.met, yield~col*row|county, main="custom county ordering")
+```
 ## References