returning tibbles instead of data.frames

ref #415

R/redcap-dag-read.R

@@ -1,7 +1,7 @@
 #' @title Read data access groups from a REDCap project
 #'
 #' @description This function reads all available data access groups from
-#'   REDCap an returns them as a [base::data.frame()].
+#'   REDCap an returns them as a [tibble::tibble()].
 #'
 #' @param redcap_uri The
 #' [uri](https://en.wikipedia.org/wiki/Uniform_Resource_Identifier)/url
@@ -23,7 +23,7 @@
 #' `httr` package.
 #'
 #' @return Currently, a list is returned with the following elements:
-#' * `data`: An R [base::data.frame()] of all data access groups of the project.
+#' * `data`: A [tibble::tibble()] of all data access groups of the project.
 #' * `success`: A boolean value indicating if the operation was apparently
 #' successful.
 #' * `status_codes`: A collection of
@@ -117,7 +117,7 @@ redcap_dag_read <- function(
       # Override the 'success' determination from the http status code.
       #   and return an empty data.frame.
       kernel$success   <- FALSE
-      ds               <- data.frame()
+      ds               <- tibble::tibble()
       outcome_message  <- sprintf(
         "The REDCap read failed.  The http status code was %i.  The 'raw_text' returned was '%s'.",
         kernel$status_code,
@@ -126,7 +126,7 @@ redcap_dag_read <- function(
       # nocov end
     }
   } else { # kernel fails
-    ds              <- data.frame() #Return an empty data.frame
+    ds              <- tibble::tibble() # Return an empty data.frame
     outcome_message <- if (any(grepl(kernel$regex_empty, kernel$raw_text))) {
       "The REDCapR read/export operation was not successful.  The returned dataset was empty."  # nocov
     } else {

R/redcap-event-instruments.R

@@ -22,7 +22,7 @@
 #' `httr` package.  See the details below. Optional.
 #'
 #' @return Currently, a list is returned with the following elements,
-#' * `data`: An R [base::data.frame()] where each row represents one column
+#' * `data`: A [tibble::tibble()] where each row represents one column
 #' in the REDCap dataset.
 #' * `success`: A boolean value indicating if the operation was apparently
 #' successful.
@@ -119,7 +119,7 @@ redcap_event_instruments <- function(
     } else {
       # nocov start
       kernel$success  <- FALSE # Override the 'success' http status code.
-      ds              <- data.frame() #Return an empty data.frame
+      ds              <- tibble::tibble() # Return an empty data.frame
 
       outcome_message <- sprintf(
         "The REDCap variable retrieval failed.  The http status code was %i.  The 'raw_text' returned was '%s'.",
@@ -129,7 +129,7 @@ redcap_event_instruments <- function(
       # nocov end
     }
   } else {
-    ds              <- data.frame() #Return an empty data.frame
+    ds              <- tibble::tibble() # Return an empty data.frame
     outcome_message <- if (any(grepl(kernel$regex_empty, kernel$raw_text))) {
       "The REDCapR read/export operation was not successful.  The returned dataset (of instrument-events) was empty."
     } else {

R/redcap-instruments.R

@@ -24,7 +24,7 @@
 #' `httr` package.  See the details below. Optional.
 #'
 #' @return Currently, a list is returned with the following elements,
-#' * `data`: An R [base::data.frame()] where each row represents one column
+#' * `data`: A [tibble::tibble()] where each row represents one column
 #' in the REDCap dataset.
 #' * `success`: A boolean value indicating if the operation was apparently
 #' successful.
@@ -118,7 +118,7 @@ redcap_instruments <- function(
     } else {
       # nocov start
       kernel$success  <- FALSE # Override the 'success' http status code.
-      ds              <- data.frame() #Return an empty data.frame
+      ds              <- tibble::tibble() # Return an empty data.frame
 
       outcome_message <- sprintf(
         "The REDCap variable retrieval failed.  The http status code was %i.  The 'raw_text' returned was '%s'.",
@@ -128,7 +128,7 @@ redcap_instruments <- function(
       # nocov end
     }
   } else {
-    ds              <- data.frame() #Return an empty data.frame
+    ds              <- tibble::tibble() # Return an empty data.frame
     outcome_message <- if (any(grepl(kernel$regex_empty, kernel$raw_text))) {
       "The REDCapR read/export operation was not successful.  The returned dataset (of instruments) was empty."
     } else {

tests/testthat/test-dag-read.R

@@ -36,6 +36,7 @@ test_that("dag-default", {
   expect_true( actual$success)
   expect_equal(actual$status_code, 200L)
   expect_equal(actual$data, expected_data)
+  expect_s3_class(actual$data, "tbl")
 })
 
 test_that("dag-default", {
@@ -60,6 +61,7 @@ test_that("dag-default", {
   expect_true( actual$success)
   expect_equal(actual$status_code, 200L)
   expect_equal(actual$data, expected_data)
+  expect_s3_class(actual$data, "tbl")
 })
 
 rm(credential_1)

tests/testthat/test-event-instruments.R

@@ -28,6 +28,7 @@ test_that("default", {
   expect_equal(returned_object$raw_text, expected="", ignore_attr = TRUE) # dput(returned_object$raw_text)
   expect_match(returned_object$outcome_message, regexp=expected_outcome_message, perl=TRUE)
   expect_true(returned_object$success)
+  expect_s3_class(returned_object$data, "tbl")
 })
 
 test_that("Bad URI", {

tests/testthat/test-instruments-metadata.R

@@ -28,6 +28,7 @@ test_that("default", {
   expect_equal(returned_object$raw_text, expected="", ignore_attr = TRUE) # dput(returned_object$raw_text)
   expect_match(returned_object$outcome_message, regexp=expected_outcome_message, perl=TRUE)
   expect_true(returned_object$success)
+  expect_s3_class(returned_object$data, "tbl")
 })
 
 test_that("Bad URI", {