R/accessREDCap.R

In Epiconcept-Paris/STRAP-epiuf: Epiconcept Team Utility Functions for STRAP Project

#' Access REDCap data for country
#'
#' This function checks for an existing secret key and file path for the specified country.
#' If these exist, the function will proceed to download REDCap data.
#' If not, the user will be prompted to create the necessary credentials.
#'
#' @param country A character string representing the country for which REDCap data will be accessed.
#' @param filepath Directory where extracted file should be saved
#'
#' @return If a secret key and file path exist, this function will proceed to call `downloadREDCap()` with the appropriate arguments.
#'         Otherwise, it will prompt the user to create a secret key or file path, or to continue with the download without them.
#' 
#' @seealso \code{\link{downloadREDCap}} for downloading REDCap data.
#' @seealso \code{\link{grabKeyring}} for creating or getting a keyring.
#' @seealso \code{\link{setOrGetFilePath}} for setting or getting a file path.
#'
#' @export
#'
#' @examples
#' \dontrun{
#' # Request data for a fictional country 'DB'
#' accessREDCap("DB")
#' }
accessREDCap <- function(country, filepath = NULL) {
  if(existsKeyring(country)) {
    password <- grabKeyring(country)
  } else {
    stop("No keyring defined")
  }
  
  downloadREDCap(password, country, filepath)
  
  # country_filepathfull <- paste0(country,"_pathkeyfull")
  # country_filepathpartial <- paste0(country,"_pathkeypart")
  # 
  # if(existsKeyring(country_filepathfull)){
  #   country_filepath <- country_filepathfull
  #   file_path <- grabKeyring(country_filepath)
  #   downloadREDCap(password,country,file_path)
  #   
  # } else if(existsKeyring(country_filepathpartial)){
  #   country_filepath <- country_filepathpartial
  #   yearDate <- format(Sys.Date(), "%Y")
  #   month_number <- format(Sys.Date(), "%m")
  #   file_path <- grabKeyring(country_filepath)
  #   file_path <- pathToFile("SOURCES", paste0(file_path,"/", yearDate ," ", month_number))
  #   downloadREDCap(password,country,file_path)
  #   
  # } else {
  #   print("A file path, within which the downloaded data will be placed, has not been set for this country yet.") 
  #   store_file <- readline("Would you like to set one now? It may save time in future. Type (Y)es or (N)o.")
  #   if(tolower(store_file)=="y"|tolower(store_file)=="yes"){
  #     setOrGetFilePath(country)
  #     accessREDCap(country)
  #   } else {
  #     downloadREDCap(password,country)
  #   }
  # }
}