Merge pull request #52 from vubiostat/issue-10

Issue 10
vubiostat · Mar 24, 2023 · 87988ee · 87988ee
2 parents 31ceb91 + 686fbf0
commit 87988ee
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 2 deletions.
diff --git a/NEWS b/NEWS
@@ -1,5 +1,7 @@
 ## Changes in Version 2.5.0
 
+* IMPORTANT: The upcoming 3.0.0 release will be a breaking change for exportRecords. This is needed for full inversion of control to the user over type casting.
+* Fully removed deprecated redcapDbConnection
 * Added a drop= argument to exportRecords and exportReports. These columns are dropped before returning.
 * Metadata is cached in the connection object. In addition to token, url, and config elements, the following are also made available:
    * metadata
@@ -22,6 +24,7 @@ There are also flush_all and refresh_all methods.
 * Removed unused version argument from checkbox_suffix
 * Fixed error thrown in export_users when labels=TRUE
 * Greatly expanded test coverage
+* mChoice class addition if Hmisc is installed
 
 ## Changes in Version 2.4.2
 

diff --git a/R/exportRecords.R b/R/exportRecords.R
@@ -177,6 +177,7 @@ exportRecords.redcapApiConnection <-
     message("The 'proj' argument is deprecated.  Please use 'bundle' instead")
     bundle <- list(...)[["proj"]]
   }
+  message("The call syntax of exportRecords will undergo a breaking change in the upcoming 3.0.0 release. See Issue #10")
 
   if (is.numeric(records)) records <- as.character(records)
 

diff --git a/tests/testthat/test-exportRecords.R b/tests/testthat/test-exportRecords.R
@@ -3,7 +3,7 @@ context("exportRecords")
 rcon <- redcapConnection(url = url, token = API_KEY)
 
 test_that("records can be exported",{
-  expect_silent(rec <- exportRecords(rcon))
+  expect_message(rec <- exportRecords(rcon))
   expect_gte(length(rec), 1)
 })
 

diff --git a/tests/testthat/test-fieldToVar-mChoice.R b/tests/testthat/test-fieldToVar-mChoice.R
@@ -7,7 +7,7 @@ rcon <- redcapConnection(url = url, token = API_KEY)
 test_that("records can be exported with Hmisc attached",{
   skip_if(!requireNamespace("Hmisc", quietly=TRUE), 
           "Hmisc is required to test mChoice export")
-  expect_silent(rec <- exportRecords(rcon))
+  expect_message(rec <- exportRecords(rcon))
   expect_gte(length(rec), 1)
 })