R/get_teams.R

In WorldHealthOrganization/godataR: Connecting R with the Go.Data Application

#' #' Get teams data from Go.Data
#'
#' A function to retrieve a list of all teams
#' data and their attributes, across all outbreaks
#' on the instance (since this is a system-level API
#' endpoint). This function relies on the
#' `\teams` API endpoint.
#'
#' @param url Insert the base URL for your instance of Go.Data here. Don't
#' forget the forward slash "/" at end!
#' @param username The email address for your Go.Data login.
#' @param password The password for your Go.Data login
#'
#' @return
#' Returns a data frame of teams associated with Go.Data instance.
#' @export
#' @examples
#' \dontrun{
#' url <- "https://MyGoDataServer.com/"
#' username <- "myemail@email.com"
#' password <- "mypassword"
#'
#' teams <- get_teams(
#'   url = url,
#'   username = username,
#'   password = password
#' )
#' }
#' @export
get_teams <- function(url,
                      username,
                      password) {

  teams_request <- httr::GET(
    paste0(
      url,
      "api/teams",
      "?access_token=",
      get_access_token(
        url = url,
        username = username,
        password = password
      )
    )
  )
  teams_content <- httr::content(teams_request, as = "text")
  teams <- jsonlite::fromJSON(teams_content, flatten = TRUE)
  teams <- dplyr::filter(teams, .data$deleted != TRUE)
  teams <- tibble::as_tibble(teams)

  return(teams)
}