message for now, deprecation at 2.1 #297

ncss-tech · Nov 18, 2023 · e11157e · e11157e
1 parent 4c54b53
commit e11157e
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 3 deletions.
diff --git a/NEWS.md b/NEWS.md
@@ -1,6 +1,7 @@
 # aqp 2.0.2 (2023-11-18)
  * CRAN release
  * new function `col2Munsell()` generalizes and replaces `rgb2munsell()` (thanks Shawn Salley for the suggestion)
+   - `rgb2munsell()` will be deprecated in aqp 2.1 
  * new function `warpHorizons()` for warping horizon thickness (inflate/deflate) (thanks Shawn Salley for idea / inspiration)
  * fixed minor bug in `plotColorMixture()` when final mixed color does not exist in spectral library
  * fixed minor namespace collision in `groupedProfilePlot()`

diff --git a/R/munsell2rgb.R b/R/munsell2rgb.R
@@ -1,7 +1,7 @@
 
 #' @title sRGB to Munsell Color Conversion
 #' 
-#' @description Convert sRGB color coordinates to the closest `n` Munsell chips in the `munsell` lookup table. This function will be replaced by `col2Munsell()` in future versions of aqp.
+#' @description Convert sRGB color coordinates to the closest `n` Munsell chips in the `munsell` lookup table. This function will be replaced by `col2Munsell()` in **aqp 2.1**.
 #'  
 #'
 #' @param color a `data.frame` or `matrix` object containing sRGB coordinates in the range of (0,1)
@@ -46,8 +46,10 @@
 #'
 rgb2munsell <- function(color, colorSpace = c('CIE2000', 'LAB', 'sRGB'), nClosest = 1) {
 
-  # 2023-11-17
-  .Deprecated(new = 'col2Munsell', msg = 'please use col2Munsell() instead.')
+  ## !! will deprecate in aqp 2.1
+  # .Deprecated(new = 'col2Munsell', msg = 'please use col2Munsell() instead.')
+  message('rgb2munsell() will be deprecated in aqp 2.1, please use col2Munsell() instead.')
+
 
   # argument check
   colorSpace <- match.arg(colorSpace)