add optional csv export for tabs, change function name to reflect

Author: the-mayer

DESCRIPTION

@@ -32,7 +32,8 @@ Imports:
     ghql,
     openxlsx,
     tidyr,
-    rvest
+    rvest,
+    readr
 Suggests:
     gargle,
     gitcreds,

NAMESPACE

@@ -2,7 +2,7 @@
 
 export(cfde_opportunity_numbers)
 export(epmc_search)
-export(export_excel)
+export(export_tabular)
 export(ga_dataframe)
 export(ga_meta_simple)
 export(ga_query_explorer)
@@ -52,6 +52,7 @@ importFrom(purrr,map_chr)
 importFrom(purrr,map_dbl)
 importFrom(purrr,map_dfr)
 importFrom(purrr,pmap)
+importFrom(readr,write_csv)
 importFrom(rlang,"%||%")
 importFrom(rlang,.data)
 importFrom(rlang,abort)

R/export.R

@@ -1,11 +1,13 @@
-#' Export to Excel
+#' Export to Tabular
 #' 
 #' @param core_project_numbers A character vector of NIH Core Project Numbers
 #' @param token The token required for authentication with the GitHub API
 #' @param service_account_json A character string containing the path to a JSON file containing a Google service account
 #' @param dir A character string containing the path to directory where the Excel file will be written
+#' @param csv A logical indicating whether to write a CSV file
 #' 
 #' @importFrom openxlsx createWorkbook addWorksheet writeData saveWorkbook
+#' @importFrom readr write_csv
 #' @importFrom rlang .data
 #' @export
 #' 
@@ -14,7 +16,7 @@
 #' test_projects <-c("OT2OD030545")
 #' }
 #' 
-export_excel <- function(core_project_numbers, token = gitcreds::gitcreds_get()$password, service_account_json = 'cfde-access-keyfile.json', dir) {
+export_tabular <- function(core_project_numbers, token = gitcreds::gitcreds_get()$password, service_account_json = 'cfde-access-keyfile.json', dir, csv = FALSE) {
 
   ## Create Excel Workbook
   wb <- createWorkbook()
@@ -23,6 +25,9 @@ export_excel <- function(core_project_numbers, token = gitcreds::gitcreds_get()$
   addWorksheet(wb, "project_info")
   proj_info <- get_core_project_info(core_project_numbers)
   writeData(wb = wb, sheet = "project_info", x = proj_info, na.string = "")
+  if (csv) {
+    write_csv(proj_info, file.path(dir, paste0("programets_proj_info_", Sys.Date(), ".csv", sep = "")))
+  }
 
   ## Add Assosciated Publications
   addWorksheet(wb, "pub_info")
@@ -31,16 +36,25 @@ export_excel <- function(core_project_numbers, token = gitcreds::gitcreds_get()$
     pull('pmid')
   pub_info <- icite(pmids)
   writeData(wb = wb, sheet = "pub_info", x = pub_info, na.string = "")
+  if (csv) {
+    write_csv(pub_info, file.path(dir, paste0("programets_pub_info_", Sys.Date(), ".csv", sep = "")))
+  }
 
   ## Add GitHub
   addWorksheet(wb, "github_info")
   github_info <- get_github_by_topic_graphql(core_project_numbers, token = token)
   writeData(wb = wb, sheet = "github_info", x = github_info, na.string = "")
+  if (csv) {
+    write_csv(github_info, file.path(dir, paste0("programets_github_info_", Sys.Date(), ".csv", sep = "")))
+  }
 
   ## Add Google Analytics
   addWorksheet(wb, "ga_info")
   ga_info <- get_ga_basic(core_project_numbers = core_project_numbers, service_account_json = service_account_json)
   writeData(wb = wb, sheet = "ga_info", x = ga_info, na.string = "")
+  if (csv) {
+    write_csv(ga_info, file.path(dir, paste0("programets_ga_info_", Sys.Date(), ".csv", sep = "")))
+  }
 
   ## Save Workbook
   saveWorkbook(wb, file.path(dir, paste0("programets_", Sys.Date(), ".xlsx", sep = "")))

man/export_excel.Rd man/export_tabular.Rdman/export_excel.Rd renamed to man/export_tabular.Rd

@@ -1,20 +1,20 @@
 library(gitcreds)
 
-test_that("export_excel writes an Excel file", {
+test_that("export_tabular writes an Excel file", {
   temp_file <- file.path(tempdir(), paste0("programets_", Sys.Date(), ".xlsx", sep = ""))
   on.exit(unlink(temp_file))
   core_project_numbers <- c("OT2OD030545")
   token <- gitcreds_get()$password
-  export_excel(core_project_numbers = core_project_numbers, token = token, dir = tempdir())
+  export_tabular(core_project_numbers = core_project_numbers, token = token, dir = tempdir())
   expect_true(file.exists(temp_file))
 })
 
-test_that("export_excel throws an error if the file already exists", {
+test_that("export_tabular throws an error if the file already exists", {
   temp_file <- file.path(tempdir(), paste0("programets_", Sys.Date(), ".xlsx", sep = ""))
   on.exit(unlink(temp_file))
   core_project_numbers <- c("OT2OD030545")
   token <- gitcreds_get()$password
   file.create(temp_file)
-  expect_error(export_excel(core_project_numbers = core_project_numbers, token = token, dir = tempdir()), "File already exists")
+  expect_error(export_tabular(core_project_numbers = core_project_numbers, token = token, dir = tempdir()), "File already exists")
 })