Add quiet parameter to all API calls (#105)

* Add quiet parameter to all API calls. * Make URL calls quiet by default
pepfar-datim · Aug 2, 2022 · 81b7438 · 81b7438
1 parent 455b6e4
commit 81b7438
Show file tree

Hide file tree

Showing 13 changed files with 150 additions and 87 deletions.
diff --git a/R/callDATIMapi.R b/R/callDATIMapi.R
@@ -8,12 +8,15 @@
 #' @param timeout how long should a reponse be waited for
 #' @param api_version defaults to current but can pass in version number
 #' @param verbose return raw content with data
+#' @param quiet Echo the URL which is called to the console.
 #' @return Result of DATIM API query returned as named list.
 #'
 api_get <- function(path,
                     d2_session,
                     retry = 1, timeout = 60,
-                    api_version = NULL, verbose = FALSE) {
+                    api_version = NULL,
+                    verbose = FALSE,
+                    quiet = TRUE) {
 
   base_url <- d2_session$base_url
   handle <- d2_session$handle
@@ -77,7 +80,10 @@ api_get <- function(path,
 
   # removes whitespace
   url <- gsub(" ", "", url)
-  print(url)
+  if (!quiet) {
+    print(url)
+  }
+
   # retry api get block, only retries if reponse code not in 400s
   i <- 1
   response_code <- 5

diff --git a/R/getAnalytics.R b/R/getAnalytics.R
@@ -21,6 +21,7 @@
 #' it will be made upon logining in to datim with loginToDATIM
 #' @param retry retry
 #' @param verbose return raw content with data
+#' @param quiet Echo the URL which is called to the console if TRUE.
 #' @return data frame with the rows of the response
 
 getAnalytics <-  function(...,
@@ -33,7 +34,8 @@ getAnalytics <-  function(...,
                           d2_session = dynGet("d2_default_session", inherits = TRUE),
                           retry = 1,
                           timeout = 60,
-                          verbose = FALSE) {
+                          verbose = FALSE,
+                          quiet = TRUE) {
 
   # cap time out at 5 minutes
   if (timeout > 300) {
@@ -81,7 +83,8 @@ getAnalytics <-  function(...,
                   d2_session = d2_session,
                   retry = retry,
                   timeout = timeout,
-                  verbose = verbose)
+                  verbose = verbose,
+                  quiet = quiet)
 
   if (verbose) {
     meta_data <- resp$api_responses

diff --git a/R/getDataValueSets.R b/R/getDataValueSets.R
@@ -11,14 +11,16 @@
 #' @param retry number of times to retry
 #' @param timeout number of seconds to wait during call
 #' @param verbose return raw content with data
+#' @param quiet Echo the URL which is called to the console if TRUE.
 #' @return  Data frame with the data requested
 #'
 getDataValueSets <- function(variable_keys = NULL, #keys,
                              variable_values = NULL, #values,
                              d2_session = dynGet("d2_default_session",
                                                  inherits = TRUE),
                              retry = 1, timeout = 180,
-                             verbose = FALSE) {
+                             verbose = FALSE,
+                             quiet = TRUE) {
 
   #Test that the provided variables have their associated values used for
   # munging
@@ -80,7 +82,8 @@ getDataValueSets <- function(variable_keys = NULL, #keys,
       d2_session = d2_session,
       retry = retry,
       timeout = timeout,
-      verbose = verbose
+      verbose = verbose,
+      quiet = quiet
     )
 
     if (verbose) {

diff --git a/R/getMetadata.R b/R/getMetadata.R
@@ -80,6 +80,7 @@ simplifyStructure <- function(resp) {
 #' @param retry number of times to retry
 #' @param timeout integer - seconds to wait for a response, default = 180
 #' @param verbose return raw content with data
+#' @param quiet Echo the URL which is called to the console if TRUE.
 #' @return the metadata response in json format and flattened
 #'
 
@@ -90,7 +91,9 @@ getMetadata <- function(end_point,
                         d2_session = dynGet("d2_default_session",
                                             inherits = TRUE),
                         retry = 1,
-                        timeout = 180, verbose = FALSE) {
+                        timeout = 180,
+                        verbose = FALSE,
+                        quiet = TRUE) {
   if (!is.character(fields)) {
     stop("The fields argument of getMetadata should be of type character")
   }
@@ -127,7 +130,8 @@ getMetadata <- function(end_point,
     path = path, d2_session = d2_session, retry = retry,
     timeout = timeout,
     api_version = NULL,
-    verbose = verbose
+    verbose = verbose,
+    quiet = quiet
   )
 
   if (verbose) {