Allow specifying format for metadata downloads to allow for json download when csv fails

Author: januz

R/redcap-metadata-read.R

@@ -8,6 +8,7 @@
 #' project.  Required.
 #' @param token The user-specific string that serves as the password for a
 #' project.  Required.
+#' @param format Format to download the metadata in. The default is "csv".
 #' @param forms An array, where each element corresponds to the REDCap form
 #' of the desired fields.  Optional.
 #' @param forms_collapsed A single string, where the desired forms are
@@ -71,6 +72,7 @@
 redcap_metadata_read <- function(
   redcap_uri,
   token,
+  format            = "csv",
   forms             = NULL,
   forms_collapsed   = "",
   fields            = NULL,
@@ -95,7 +97,7 @@ redcap_metadata_read <- function(
   post_body <- list(
     token    = token,
     content  = "metadata",
-    format   = "csv",
+    format   = format,
     forms    = forms_collapsed,
     fields   = fields_collapsed
   )
@@ -112,11 +114,17 @@ redcap_metadata_read <- function(
 
     try(
       # Convert the raw text to a dataset.
-      ds <-
-        readr::read_csv(
-          kernel$raw_text,
-          col_types = col_types
-        ),
+      if (format == "csv") {
+        ds <-
+          readr::read_csv(
+            kernel$raw_text,
+            col_types = col_types
+          )
+      } else if (format == "json") {
+          json_df <- jsonlite::fromJSON(kernel$raw_text)
+          json_tibble <- tibble::as_tibble(json_df)
+          ds <- dplyr::mutate_all(json_tibble, ~ dplyr::na_if(.x, ""))
+      },
       # Don't print the warning in the try block.  Print it below,
       #   where it's under the control of the caller.
       silent = TRUE

R/redcap-read.R

@@ -19,6 +19,7 @@
 #' project.  Required.
 #' @param token The user-specific string that serves as the password for a
 #' project.  Required.
+#' @param format Format to download the metadata in. The default is "csv".
 #' @param records An array, where each element corresponds to the ID of a
 #' desired record.  Optional.
 #' @param records_collapsed A single string, where the desired ID values are
@@ -173,6 +174,7 @@ redcap_read <- function(
   continue_on_error             = FALSE,
   redcap_uri,
   token,
+  format                        = "csv",
   records                       = NULL, records_collapsed = "",
   fields                        = NULL, fields_collapsed  = "",
   forms                         = NULL, forms_collapsed   = "",
@@ -242,7 +244,8 @@ redcap_read <- function(
     redcap_uri         = redcap_uri,
     token              = token,
     verbose            = verbose,
-    config_options     = config_options
+    config_options     = config_options,
+    format             = format
   )
 
   # if (!metadata$success) {