Update NEWS and package startup message #113

vubiostat · Jun 30, 2023 · c988b5f · c988b5f
1 parent 6ce2881
commit c988b5f
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 18 deletions.
diff --git a/NEWS b/NEWS
@@ -1,3 +1,15 @@
+## DEPRECATION NOTICES
+
+A future release of version 3.0.0 will introduce several breaking changes!
+
+* The `exportRecords` function interface will be replaced. Please switch your processes to `exportRecordsTyped`
+* The `exportReports` function interface will be replaced. Please switch your processes to `exportReportsTyped`
+* The `importRecords` function interface will be replaced to utilize `castForImport` to prepare data for import. Validation logs will no longer be printed.
+* The `redcapFactor` class is being discontinued with all its supporting methods (including `redcapFactorFlip`). Please use `recastRecords` instead.
+* The `recodeCheck` function is being discontinued. Please use `recastRecords` instead.
+* The `exportProjectInfo` and `exportBundle` functions are being discontinued. Their functionality is replaced by caching values on the connection object.
+* The `cleansMetaData` function is being discontinued.
+
 ## 2.7.3
 
 * dags: Added ability to get DAG information from connection object, e.g. `rcon$dags()`

diff --git a/R/zzz.R b/R/zzz.R
@@ -1,30 +1,22 @@
 packageStartupMessage(
-  "Welcome to redcapAPI.  Please Note:\n",
-  " - 'exportBundle' has been made redundant. See ?redcapConnection for details about caching project data.")
+  "A future release of redcapAPI 3.0.0 will introduce several breaking changes \n",
+  "* The `exportRecords` function interface will be replaced. Please switch your processes to `exportRecordsTyped`\n",
+  "* The `exportReports` function interface will be replaced. Please switch your processes to `exportReportsTyped`\n",
+  "* The `importRecords` function interface will be replaced to utilize `castForImport` to prepare data for import.\n ",
+  "* The `redcapFactor` class is being discontinued with all its supporting methods (including `redcapFactorFlip`.\n",
+  "* The `exportProjectInfo` and `exportBundle` functions are being discontinued. Their functionality is replaced by caching values on the connection object.\n", 
+  "See NEWS for more details."
+)
 
 .onLoad <- function(libname,pkgname)
 {
   options(redcap_api_url = character(0),
-          redcap_error_handling = "null",
-          redcap_bundle = 
-            structure(
-              list(
-                version = NULL,
-                meta_data = NULL,
-                users = NULL,
-                instruments = NULL,
-                events = NULL,
-                arms = NULL,
-                mappings = NULL
-              ),
-              class = c("redcapBundle", "redcapProject", "list")
-            )
+          redcap_error_handling = "null"
   )
 }
 
 .onUnload <- function(libPath)
 {
   options(redcap_api_url = NULL,
-          redcap_error_handling = NULL,
-          redcap_bundle = NULL)
+          redcap_error_handling = NULL)
 }