Fix list_party_volumes(); fix typo in list_party_sponsors().

Author: rogilmore

R/list_party_sponsors.R

@@ -37,8 +37,6 @@ list_party_sponsors <- function(party_id = 6,
     rq <- make_default_request()
   }
 
-  party_info <- get_party_by_id(party_id, vb, rq)
-  
   if (vb)
     message(paste0("Getting sponsors for party ", party_id, "."))
 

R/list_party_volumes.R

@@ -29,30 +29,67 @@ list_party_volumes <- function(party_id = 6,
   if (is.null(rq)) {
     if (vb) {
       message("NULL request object. Will generate default.")
-      message("\nNot logged in. Only public information will be returned.")  
+      message("\nNot logged in. Only public information will be returned.")
     }
     rq <- databraryr::make_default_request()
   }
 
-  g <- databraryr::get_party_by_id(party_id, vb, rq)
+  vol_id <- NULL
 
-  if (!is.null(g)) {
+  if (vb)
+    message(paste0("Retrieving data for party ", party_id, "."))
+  party_info <- databraryr::get_party_by_id(party_id, vb, rq)
+  
+  if (!is.null(party_info)) {
     if (vb)
-      message(paste0("Retrieving data for party ", party_id, "."))
-    purrr::map(
-      g$access,
-      .f = function(x) {
-        as.data.frame(x[[3]])
-      }
-    ) %>% purrr::list_rbind() %>%
-      dplyr::mutate(party_id = party_id, 
-                    prename = g$prename,
-                    sortname = g$sortname,
-                    affiliation = g$affiliation)
+      message(paste0("Info retrieved. Filtering."))
+    purrr::map(party_info$access, extract_vol_fr_party) %>%
+      purrr::list_rbind() %>%
+      dplyr::mutate(
+        party_id = party_id,
+        party_prename = party_info$prename,
+        party_sortname = party_info$sortname,
+        party_affiliation = party_info$affiliation
+      ) %>%
+      dplyr::arrange(vol_id)
   } else {
     if (vb)
       message(paste0("No data for party ", party_id, "."))
-    g
+    party_info
   }
-  #TODO: Reformat output
 }
+
+#---------------------------------------------------------------------------
+# This is a private, not exported,
+# helper function for list_party_volumes()
+#
+extract_vol_fr_party <- function(p_info) {
+  assertthat::assert_that(is.list(p_info))
+
+  this_vol <- p_info$volume
+  
+  vol_names <- names(this_vol)
+  assertthat::assert_that("id" %in% vol_names)
+  assertthat::assert_that("name" %in% vol_names)
+  assertthat::assert_that("body" %in% vol_names)
+  assertthat::assert_that("creation" %in% vol_names)
+  assertthat::assert_that("permission" %in% vol_names)
+  
+  vol_id <- this_vol$id
+  vol_name <- this_vol$name
+  vol_body <- this_vol$body
+  if (!("alias" %in% vol_names)) {
+    vol_alias = NA
+  } else {
+    vol_alias <- this_vol$alias    
+  }
+  vol_creation <- this_vol$creation
+  vol_permission <- this_vol$permission
+  
+  tibble::tibble(vol_id,
+                 vol_name,
+                 vol_body,
+                 vol_alias,
+                 vol_creation,
+                 vol_permission)
+}

vignettes/authorized-users.Rmd

@@ -80,27 +80,27 @@ To do this, use the `store` and `overwrite` parameters in `login_db()`:
 
 ```{r, eval=FALSE}
 databraryr::login_db(email = "<YOUR_EMAIL@PROVIDER.COM>", store = TRUE,
-                     overwrite = TRUE, rq = lrq)
+                     overwrite = TRUE, rq = drq)
 ```
 
 This overwrites and securely stores your credentials, so that the next time you log in, you need only use this command:
 
 ```{r, eval=FALSE}
-databraryr::login_db(email = "<YOUR_EMAIL@PROVIDER.COM>", store = TRUE, rq = lrq)
+databraryr::login_db(email = "<YOUR_EMAIL@PROVIDER.COM>", store = TRUE, rq = drq)
 ```
 
 or if you've stored your email as an environment variable:
 
 ```{r, eval=FALSE}
-databraryr::login_db(email = Sys.getenv("DATABRARY_LOGIN"), store = TRUE, rq = lrq)
+databraryr::login_db(email = Sys.getenv("DATABRARY_LOGIN"), store = TRUE, rq = drq)
 ```
 
 ### Logging out
 
 The package also has a log out command.
 
 ```{r eval=FALSE}
-databraryr::logout_db(rq = lrq)
+databraryr::logout_db(rq = drq)
 ```
 
 **NOTE**: Most `databraryr` functions have a verbose (`vb`) parameter. If you set this to `TRUE`, you will get more information about what's going on.