Progress deprecation of in.place argument

Author: MichaelChirico

NEWS.md

@@ -137,6 +137,8 @@ rowwiseDT(
 
 6. `measurev()` was implemented and documented in v1.15.0, for use within `melt()`, and it is now exported (dependent packages can now use without a NOTE from CRAN check).
 
+7. Deprecation of `droplevels(in.place=TRUE)` (warning since v1.16.0) has been upgraded from warning to error. The argument will be removed in the next release.
+
 # data.table [v1.16.2](https://github.com/Rdatatable/data.table/milestone/35) (9 October 2024)
 
 ## BUG FIXES

R/fdroplevels.R

@@ -8,10 +8,9 @@ fdroplevels = function(x, exclude = if (anyNA(levels(x))) NULL else NA, ...) {
   return(ans)
 }
 
-droplevels.data.table = function(x, except=NULL, exclude, in.place=FALSE, ...){
-  stopifnot(is.logical(in.place))
-  if (isTRUE(in.place)) warningf("droplevels() with in.place=TRUE is deprecated. Use setdroplevels() instead.")
-  if (!in.place) x = copy(x)
+droplevels.data.table = function(x, except=NULL, exclude, in.place=NULL, ...){
+  if (!is.null(in.place)) stopf("droplevels() with in.place=TRUE is deprecated. Use setdroplevels() instead.")
+  x = copy(x)
   if (missing(exclude)) exclude = NULL
   setdroplevels(x, except, exclude)[]
 }

inst/tests/tests.Rraw

@@ -17794,7 +17794,7 @@ if (base::getRversion() >= "3.4.0") {
 }
 test(2214.06, droplevels(DT)[["a"]], droplevels(DT[1:5,a]))
 test(2214.07, droplevels(DT, 1)[["a"]], x[1:5])
-test(2214.08, droplevels(DT, in.place=TRUE), DT, warning="droplevels() with in.place=TRUE is deprecated.")
+test(2214.08, droplevels(DT, in.place=TRUE), error="droplevels() with in.place=TRUE is deprecated.")
 # support ordered factors in fdroplevels
 o = factor(letters[1:10], ordered=TRUE)
 test(2214.09, fdroplevels(o[1:5]), droplevels(o[1:5]))

man/fdroplevels.Rd

@@ -12,13 +12,13 @@
 fdroplevels(x, exclude = if (anyNA(levels(x))) NULL else NA, \dots)
 setdroplevels(x, except = NULL, exclude = NULL)
 
-\method{droplevels}{data.table}(x, except = NULL, exclude, in.place = FALSE, \dots)
+\method{droplevels}{data.table}(x, except = NULL, exclude, in.place = NULL, \dots)
 }
 \arguments{
   \item{x}{ \code{factor} or \code{data.table} where unused levels should be dropped. }
   \item{exclude}{ A \code{character} vector of factor levels which are dropped no matter of presented or not. }
   \item{except}{ An \code{integer} vector of indices of data.table columns which are not modified by dropping levels. }
-  \item{in.place}{ logical (default is \code{FALSE}). If \code{TRUE} levels of factors of \code{data.table} are modified in-place. }
+  \item{in.place}{ Deprecated. Use \code{setdroplevels} for in-place modification. }
   \item{\dots}{ further arguments passed to methods }
 }