froll improve error messages (#7289)

Author: jangorecki

R/frollapply.R

@@ -141,9 +141,9 @@ frollapply = function(X, N, FUN, ..., by.column=TRUE, fill=NA, align=c("right","
     stopf("'N' must be non 0 length")
   if (!adaptive) {
     if (is.list(N))
-      stopf("'N' must be integer, list is accepted for adaptive TRUE")
+      stopf("'N' must be an integer, list is accepted for adaptive TRUE")
     else if (!is.numeric(N))
-      stopf("'N' must be integer vector")
+      stopf("'N' must be an integer")
     nnam = names(N) ## used for give.names
     if (!is.integer(N))
       N = as.integer(N)
@@ -165,13 +165,13 @@ frollapply = function(X, N, FUN, ..., by.column=TRUE, fill=NA, align=c("right","
       if (!equal.lengths(N))
         stopf("adaptive windows provided in 'N' must not to have different lengths")
       if (!all(vapply_1b(N, is.numeric, use.names=FALSE)))
-        stopf("n must be an integer vector or list of an integer vectors")
+        stopf("'N' must be an integer vector or list of integer vectors")
       if (!all(vapply_1b(N, is.integer, use.names=FALSE)))
         N = lapply(N, as.integer)
       nn = length(N)
       nnam = names(N)
     } else
-      stopf("n must be an integer vector or list of an integer vectors")
+      stopf("'N' must be an integer vector or list of integer vectors")
   }
   ## partial
   if (partial) {

inst/tests/froll.Rraw

@@ -78,22 +78,22 @@ test(6000.011, frollmean(x, n, adaptive=TRUE), list(c(NA, 1, 1.25), c(NA, 1, 1.2
 
 #### error on unsupported type
 dx = data.table(real=1:10/2, char=letters[1:10])
-test(6000.012, frollmean(dx, 3), error="x must be of type numeric or logical, or a list, data.frame or data.table of such")
+test(6000.012, frollmean(dx, 3), error="'x' must be of type numeric or logical, or a list, data.frame or data.table of such")
 dx = data.table(real=1:10/2, fact=factor(letters[1:10]))
-test(6000.013, frollmean(dx, 3), error="x must be of type numeric or logical, or a list, data.frame or data.table of such")
+test(6000.013, frollmean(dx, 3), error="'x' must be of type numeric or logical, or a list, data.frame or data.table of such")
 #dx = data.table(real=1:10/2, logi=logical(10))
 #test(6000.014, frollmean(dx, 3), error="x must be list, data.frame or data.table of numeric types") # commented out as support added in #3749, tested in .009
 dx = data.table(real=1:10/2, list=rep(list(NA), 10))
-test(6000.015, frollmean(dx, 3), error="x must be of type numeric or logical, or a list, data.frame or data.table of such")
+test(6000.015, frollmean(dx, 3), error="'x' must be of type numeric or logical, or a list, data.frame or data.table of such")
 x = letters[1:10]
-test(6000.016, frollmean(x, 3), error="x must be of type numeric or logical, or a list, data.frame or data.table of such")
+test(6000.016, frollmean(x, 3), error="'x' must be of type numeric or logical, or a list, data.frame or data.table of such")
 x = 1:10/2
-test(6000.017, frollmean(x, "a"), error="n must be integer")
-test(6000.018, frollmean(x, factor("a")), error="n must be integer")
-test(6000.019, frollmean(x, TRUE), error="n must be integer")
-test(6000.020, frollmean(x, list(1:10)), error="n must be integer, list is accepted for adaptive TRUE")
-test(6000.021, frollmean(x, list(NA), adaptive=TRUE), error="n must be an integer vector or list of an integer vectors")
-test(6000.022, frollmean(x, list(c(1:5,1:5), NA), adaptive=TRUE), error="n must be an integer vector or list of an integer vectors")
+test(6000.017, frollmean(x, "a"), error="'n' must be an integer")
+test(6000.018, frollmean(x, factor("a")), error="'n' must be an integer")
+test(6000.019, frollmean(x, TRUE), error="'n' must be an integer")
+test(6000.020, frollmean(x, list(1:10)), error="'n' must be an integer, list is accepted for adaptive TRUE")
+test(6000.021, frollmean(x, list(NA), adaptive=TRUE), error="'n' must be an integer vector or list of integer vectors")
+test(6000.022, frollmean(x, list(c(1:5,1:5), NA), adaptive=TRUE), error="'n' must be an integer vector or list of integer vectors")
 
 #### various length list vectors
 l = list(1:6/2, 3:10/4)
@@ -371,10 +371,10 @@ test(6000.086, frollmean(list(1:3, 2:4), integer()), error="n must be non 0 leng
 #### n==0 (k==0, k[i]==0)
 ## 6000.87 6000.88 moved to 6001.
 #### n<0
-test(6000.089, frollmean(1:3, -2), error="n must be non-negative integer values")
-test(6000.0891, frollmean(1:3, c(-2,2), adaptive=TRUE), error="n must be non-negative integer values")
+test(6000.089, frollmean(1:3, -2), error="'n' must be non-negative integer values (>= 0)")
+test(6000.0891, frollmean(1:3, c(-2,2), adaptive=TRUE), error="'n' must be non-negative integer values (>= 0)")
 #### n[[1L]]>0 && n[[2L]]<0
-test(6000.090, frollmean(1:3, c(2, -2)), error="n must be non-negative integer values")
+test(6000.090, frollmean(1:3, c(2, -2)), error="'n' must be non-negative integer values (>= 0)")
 #### n[[1L]]==n[[2L]]
 test(6000.091, frollmean(1:3, c(2, 2)), list(c(NA_real_, 1.5, 2.5), c(NA_real_, 1.5, 2.5)))
 test(6000.092, frollmean(list(1:3, 4:6), c(2, 2)), list(c(NA_real_, 1.5, 2.5), c(NA_real_, 1.5, 2.5), c(NA_real_, 4.5, 5.5), c(NA_real_, 4.5, 5.5)))
@@ -411,17 +411,17 @@ test(6000.111, frollmean(list(1, 10, 5), 2, align="left"), list(NA_real_, NA_rea
 test(6000.112, frollmean(5, 2, align="center"), NA_real_)
 test(6000.113, frollmean(list(1, 10, 5), 2, align="center"), list(NA_real_, NA_real_, NA_real_))
 #### n==Inf
-test(6000.114, frollmean(1:5, Inf), error="n must be non-negative integer values", warning="NAs introduced by coercion*")
+test(6000.114, frollmean(1:5, Inf), error="'n' must be non-negative integer values (>= 0)", warning="NAs introduced by coercion*")
 #### n==c(5, Inf)
-test(6000.115, frollmean(1:5, c(5, Inf)), error="n must be non-negative integer values", warning="NAs introduced by coercion*")
+test(6000.115, frollmean(1:5, c(5, Inf)), error="'n' must be non-negative integer values (>= 0)", warning="NAs introduced by coercion*")
 #### is.complex(n)
-test(6000.116, frollmean(1:5, 3i), error="n must be integer")
+test(6000.116, frollmean(1:5, 3i), error="'n' must be an integer")
 #### is.character(n)
-test(6000.117, frollmean(1:5, "a"), error="n must be integer")
+test(6000.117, frollmean(1:5, "a"), error="'n' must be an integer")
 #### is.factor(n)
-test(6000.118, frollmean(1:5, as.factor("a")), error="n must be integer")
+test(6000.118, frollmean(1:5, as.factor("a")), error="'n' must be an integer")
 #### is.list(n)
-test(6000.119, frollmean(1:5, list(1:5)), error="n must be integer, list is accepted for adaptive TRUE")
+test(6000.119, frollmean(1:5, list(1:5)), error="'n' must be an integer, list is accepted for adaptive TRUE")
 #### adaptive=NA
 test(6000.1192, frollmean(1:5, 2, adaptive=NA), error="adaptive must be TRUE or FALSE")
 #### na.rm=NA
@@ -453,7 +453,7 @@ test(6000.1197, frollmean(c(1:5,NA), 2, algo="exact", na.rm=TRUE), output=c(
 ))
 options(datatable.verbose=FALSE)
 #### adaptive=TRUE n=character
-test(6000.1198, frollmean(1:5, n=letters[1:5], adaptive=TRUE), error="n must be an integer vector or list of an integer vectors")
+test(6000.1198, frollmean(1:5, n=letters[1:5], adaptive=TRUE), error="'n' must be an integer vector or list of integer vectors")
 
 #### non-finite values (NA, NaN, Inf, -Inf)
 ma = function(x, n, na.rm=FALSE, nf.rm=FALSE) {
@@ -1293,12 +1293,12 @@ ans = frollapply(FUN=mean, x, n, align="left")
 ans[(length(x)-n-1L):length(x)] = frollapply(FUN=mean, x[(length(x)-n-1L):length(x)], n, partial=TRUE, align="left")
 test(6010.123, ans, c(1,1.5,2,2.5,2.75,3))
 ans = list(c(0.50,0.75,1.00,1.50,2.00,2.50), c(0.50,0.75,1.00,1.25,1.75,2.25))
-test(6010.131, frollapply(FUN=mean, 1:6/2, list(3L,4L), partial=TRUE), error="'N' must be integer, list is accepted for adaptive TRUE")
+test(6010.131, frollapply(FUN=mean, 1:6/2, list(3L,4L), partial=TRUE), error="'N' must be an integer, list is accepted for adaptive TRUE")
 test(6010.132, frollapply(FUN=mean, 1:6/2, 3:4, partial=TRUE), ans)
 test(6010.143, frollapply(FUN=mean, 1:4, 2L, align="center", partial=TRUE), error="'partial' cannot be used together with align='center'")
 test(6010.144, frollapply(FUN=mean, list(1:4, 2:4), n, partial=TRUE), error="'partial' does not support variable length of columns in x")
-test(6010.145, frollapply(FUN=mean, x, TRUE, partial=TRUE), error="'N' must be integer vector")
-test(6010.146, frollapply(FUN=mean, x, list(TRUE), partial=TRUE), error="'N' must be integer, list is accepted for adaptive TRUE")
+test(6010.145, frollapply(FUN=mean, x, TRUE, partial=TRUE), error="'N' must be an integer")
+test(6010.146, frollapply(FUN=mean, x, list(TRUE), partial=TRUE), error="'N' must be an integer, list is accepted for adaptive TRUE")
 ## growable failed if length was set after copy: attempt to set index 1/1 in SET_STRING_ELT
 old = setDTthreads(1L)
 test(6010.150, frollapply(c("B","B","C"), 3, unique, simplify=FALSE, partial=TRUE), list("B", "B", c("B","C")))
@@ -1324,7 +1324,7 @@ test(6010.205, frollapply(c(2,2,2,3,4), c(1,3,3,2,3), uniqueN, adaptive=TRUE), c
 test(6010.206, frollapply(1:5, c(NA,NA,3,2,3), sum, adaptive=TRUE), c(NA,NA,6L,7L,12L)) ## NAs in adaptive window are ok
 
 #### test coverage
-test(6010.501, frollapply(1:3, "b", sum), error="'N' must be integer")
+test(6010.501, frollapply(1:3, "b", sum), error="'N' must be an integer")
 test(6010.503, frollapply(1:3, integer(), sum), error="'N' must be non 0 length")
 test(6010.504, frollapply(1:3, 2L, sum, fill=1:2), list(1:2, 3L, 5L))
 test(6010.505, frollapply(1:3, 2L, sum, fill=NA_integer_), c(NA,3L,5L))
@@ -1380,8 +1380,8 @@ test(6010.545, frollapply(1:2, 2, sum, simplify=NA), error="must be TRUE or FALS
 test(6010.561, frollapply(x=1:2, N=2, FUN=sum), c(NA,3L), warning="'x' is deprecated in frollapply, use 'X' instead")
 test(6010.562, frollapply(X=1:2, n=2, FUN=sum), c(NA,3L), warning="'n' is deprecated in frollapply, use 'N' instead")
 test(6010.563, frollapply(x=1:2, n=2, FUN=sum), c(NA,3L), warning=c("'x' is deprecated in frollapply, use 'X' instead","'n' is deprecated in frollapply, use 'N' instead"))
-test(6010.564, frollapply(1:2, c("a","a"), length, adaptive=TRUE), error="n must be an integer vector or list of an integer vectors")
-test(6010.565, frollapply(1:2, list(c("a","a")), length, adaptive=TRUE), error="n must be an integer vector or list of an integer vectors")
+test(6010.564, frollapply(1:2, c("a","a"), length, adaptive=TRUE), error="'N' must be an integer vector or list of integer vectors")
+test(6010.565, frollapply(1:2, list(c("a","a")), length, adaptive=TRUE), error="'N' must be an integer vector or list of integer vectors")
 test(6010.566, frollapply(1:2, 2, length, by.column=FALSE), error="frollapply by.column=FALSE requires 'X' argument to be")
 test(6010.567, frollapply(list(1:2, list(c("a","b"))), 2, length, by.column=FALSE), error="frollapply by.column=FALSE got list in 'X' but it is not valid one")
 test(6010.568, frollapply(list(data.frame(x=1:2), data.frame(x=I(list(1:2)))), 2, length, by.column=FALSE), error="not all columns of data.frames/data.tables are atomic")

src/frollR.c

@@ -15,7 +15,7 @@ SEXP coerceX(SEXP obj) {
   for (R_len_t i=0; i<nobj; i++) {
     SEXP this_obj = VECTOR_ELT(obj, i);
     if (!(isReal(this_obj) || isInteger(this_obj) || isLogical(this_obj)))
-      error(_("x must be of type numeric or logical, or a list, data.frame or data.table of such"));
+      error(_("'x' must be of type numeric or logical, or a list, data.frame or data.table of such"));
     SET_VECTOR_ELT(x, i, coerceAs(this_obj, PROTECT(ScalarReal(NA_REAL)), /*copyArg=*/ScalarLogical(false))); // copyArg=false will make type-class match to return as-is, no copy
     UNPROTECT(1); // as= input to coerceAs()
   }
@@ -28,20 +28,20 @@ SEXP coerceK(SEXP obj, bool adaptive) {
   SEXP ans = R_NilValue;
   if (!adaptive) {
     if (isNewList(obj))
-      error(_("n must be integer, list is accepted for adaptive TRUE"));
+      error(_("'n' must be an integer, list is accepted for adaptive TRUE"));
     if (isInteger(obj)) {
       ans = obj;
     } else if (isReal(obj)) {
       ans = PROTECT(coerceVector(obj, INTSXP)); protecti++;
     } else {
-      error(_("n must be integer"));
+      error(_("'n' must be an integer"));
     }
     int nk = length(obj);
     R_len_t i = 0;
     int *iik = INTEGER(ans);
     while (i < nk && iik[i] >= 0) i++;
     if (i != nk)
-      error(_("n must be non-negative integer values (>= 0)"));
+      error(_("'n' must be non-negative integer values (>= 0)"));
   } else {
     if (isVectorAtomic(obj)) {
       ans = PROTECT(allocVector(VECSXP, 1)); protecti++;
@@ -50,7 +50,7 @@ SEXP coerceK(SEXP obj, bool adaptive) {
       } else if (isReal(obj)) {
         SET_VECTOR_ELT(ans, 0, coerceVector(obj, INTSXP));
       } else {
-        error(_("n must be an integer vector or list of an integer vectors"));
+        error(_("'n' must be an integer vector or list of integer vectors"));
       }
     } else {
       int nk = length(obj);
@@ -61,7 +61,7 @@ SEXP coerceK(SEXP obj, bool adaptive) {
         } else if (isReal(VECTOR_ELT(obj, i))) {
           SET_VECTOR_ELT(ans, i, coerceVector(VECTOR_ELT(obj, i), INTSXP));
         } else {
-          error(_("n must be an integer vector or list of an integer vectors"));
+          error(_("'n' must be an integer vector or list of integer vectors"));
         }
       }
     }
@@ -71,7 +71,7 @@ SEXP coerceK(SEXP obj, bool adaptive) {
       R_len_t ii = 0;
       while (ii < nx && iik[ii] >= 0) ii++;
       if (ii != nx)
-        error(_("n must be non-negative integer values (>= 0)"));
+        error(_("'n' must be non-negative integer values (>= 0)"));
     }
   }
   UNPROTECT(protecti);