R/get_connections.R

Defines functions get_connections

Documented in get_connections

#' Call that lists out the connections of a superhero.
#'
#' @param access_token Required. Unique token obtained from the SuperHero API site. Token should be set to the environment and will be retrieved
#' that way.
#' @param character_id Required. The \href{https://superheroapi.com/ids.html}{Character ID} or name of the Superhero
#
#' @return Returns a dataframe with the connections/occupation  of the specific superhero.
#' @export
#'
#'

get_connections <- function(access_token = Sys.getenv("SUPERHERO_TOKEN"), character_id) {

  if(is.character({{character_id}})) {

    load(file = here("data", "character_ids.rda"))

    cnvrt_char_str <- character_ids %>%
      filter(character == str_to_title({{character_id}})) %>%
      select(id) %>%
      pluck('id')

    base_url <- glue('https://superheroapi.com/api/{access_token}/{cnvrt_char_str}/connections')

    results <- GET(url = base_url)

    connections_df <- fromJSON(rawToChar(results$content)) %>%
      as_tibble()

    return(connections_df)

  } else{

    base_url <- glue('https://superheroapi.com/api/{access_token}/{character_id}/connections')

    results <- GET(url = base_url)

    connections_df <- fromJSON(rawToChar(results$content)) %>%
      as_tibble()

    return(connections_df)
  }

}
Edgar-Zamora/superheroR documentation built on Dec. 17, 2021, 6:22 p.m.