210 depracate datanames in teal.data::get_code

NEWS.md

@@ -1,5 +1,10 @@
 # teal.data 0.6.0.9012
 
+### Deprecations
+
+- `get_code(datanames)` `S4` method parameter for `teal_data()` object was soft deprecated. Use `get_code(names)`.
+
+
 ### Enhancements
 
 - `datanames()`

R/teal_data-get_code.R

@@ -1,6 +1,6 @@
 #' Get code from `teal_data` object
 #'
-#' Retrieve code from `teal_data` object.
+#' `r lifecycle::badge("deprecated")` Retrieve code from `teal_data` object.
 #'
 #' Retrieve code stored in `@code`, which (in principle) can be used to recreate all objects found in `@env`.
 #' Use `datanames` to limit the code to one or more of the datasets enumerated in `@datanames`.
@@ -108,6 +108,12 @@ setMethod("get_code", signature = "teal_data", definition = function(object, dep
   checkmate::assert_flag(deparse)
 
   code <- if (!is.null(datanames)) {
+    lifecycle::deprecate_warn(
+      when = "0.6.1",
+      what = "teal.data::get_code(datanames)",
+      with = "teal.code::get_code(names)",
+      always = TRUE
+    )
     get_code_dependency(object@code, datanames, ...)
   } else {
     object@code

vignettes/teal-data-reproducibility.Rmd

@@ -87,7 +87,7 @@ verify(data_wrong) # fails verification, raises error
 ## Retrieving code
 
 The `get_code` function is used to retrieve the code stored in a `teal_data` object.
-A simple `get_code(<teal_data>)` will return the entirety of the code but using the `datanames` argument allows for obtaining a subset of the code that only deals with some of the objects stored in `teal_data`.
+A simple `get_code(<teal_data>)` will return the entirety of the code but using the `names` argument allows for obtaining a subset of the code that only deals with some of the objects stored in `teal_data`.
 
 ```{r}
 library(teal.data)
@@ -98,7 +98,7 @@ data <- within(teal_data(), {
   head(i)
 })
 cat(get_code(data)) # retrieve all code
-cat(get_code(data, datanames = "i")) # retrieve code for `i`
+cat(get_code(data, names = "i")) # retrieve code for `i`
 ```
 
 Note that in when retrieving code for a specific dataset, the result is only the code used to _create_ that dataset, not code that _uses_ is.