R/retrieveProjects.R

In magmaR: R-Client for 'Magma' of the 'UCSF Mount Etna Data Library'

#' Helper function that retrieves all the projectName options which a user has access to, from janus.
#' @inheritParams retrieve
#' @param verbose Logical. Sets whether to report the status of the '/projects' curl request sent to janus.
#' @details
#' This function takes in the user's \code{target} containing their authorization token, and a url targeting either magma or janus.
#' It then converts the given url to target janus, and makes a curl request to <janus-url>/projects in order to return which projects a user can access.
#' @return A data.frame where elements of the 'project_name' column reflect what can be given to \code{projectName} inputs of other magmaR functions.
#' @export
#' @examples
#' 
#' if (interactive()) {
#'     retrieveProjects(target = magmaRset())
#' }
#' 
retrieveProjects <- function(
    target,
    verbose = FALSE
) {
    
    # Swap in 'janus' for 'magma' in the target url
    target$url <- gsub("magma", "janus", target$url)
    
    return <- .perform_curl_get(
        fxn = c("/projects"),
        target = target,
        requestBody = NULL,
        parse = TRUE,
        verbose = verbose)
    
    jsonlite::fromJSON(
        return
        )$projects
}