R API Wrapper

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
# Creating pokeAPI get requests
#'
#' The poke_api() function takes in variable part of the path required
#' for the GET request to the pokeAPI servers.
#'
#' @import jsonlite httr tidyverse stringr dplyr
#'
#' @param path The pokeAPI parameter to pull data for
#'
#' @return The json response from the pokeAPI
#' @export
#'
#' @examples
#' poke_api("/pokemon-species/1")

poke_api <- function(path){
  out <- tryCatch(
    {
      url <- modify_url("https://pokeapi.co", path=paste("/api/v2",path, sep=""))
      response <- GET(url, timeout(10))
      if (http_error(response)){
        if (round(status_code(response)/100,0)==5 | path==500){ # NOTE: all path==500 checks are for testing purposes only (allows simulation of inability to reach API)
          if (path == 500){
            # If 500 was passed in set the response to 500 so that the while loop can be tested
            response = 500
          }
          # If the error status code is in the 500 range attempt to call the API up to 5 more times, with a timed delay between calls
          delayTime <- 1
          while (round(status_code(response)/100,0)==5 & delayTime<=16){
            Sys.sleep(delayTime) # Delay time between calls
            response <- GET(url, timeout(10)) # Attempting to reach the API again
            # Exponential backoff of request time +/- randomly selected value between 0+5% of current delay time
            delayTime = delayTime*2+runif(1, -delayTime*0.05, delayTime*0.05)
            # For Testing when the API can't be reached
          }
          if (round(status_code(response)/100,0)==5 | path==500){
            stop("Unable to reach API", call. = FALSE)
          }
        } else if (round(status_code(response)/100,0)==4){
          stop("Invalid Input Path", call. = FALSE)
        }
      }
      return(response)
    },
  error=function(cond){
    print(gsub("\n","",gettext(cond)))
  })
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
#' Create a Data Frame with Aggregated Data from pokeframe
#'
#' The poke.summary() function counts the number of Pokémon and mean of capture rate grouped
#' by either 'habitat' or type' from pokeframe data frame.
#'
#'
#' @param pokeframe The data frame of pokemon to summarise
#' @param infoType The type of information to summarise 'habitat' or 'type'
#'
#' @return A data frame
#' @export
#'
#' @examples
#' \dontrun{
#' poke.summary(pokeframe, 'habitat')
#' poke.summary(pokeframe, 'type')
#' }

poke.summary <- function(pokeframe, infoType){
  if (infoType == "habitat"){
    # Count of pokemon in each habitat
    group_by(pokeframe, habitat) %>% summarise(pokemonCount=n(), meanCaptureRate=round(mean(captureRate, na.rm = TRUE)))
  } else if (infoType == "type"){
    # Count of pokemon in each type
    group_by(pokeframe, type) %>% summarise(pokemonCount=n(), meanCaptureRate=round(mean(captureRate, na.rm = TRUE)))
  } else{
    print("Invalid Request")
  }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
#' Create a Data Frame Filtered by Pokémon
#'
#' The poke.filter() function filters the pokeframe data frame by pokemon names
#' selected in a vector,
#'
#'
#' @param pokeframe The data frame of pokemon to summarise
#' @param vec the name(s) of the pokemon being filtered, accepts a string for a single pokemon, or a list for multiple
#'
#' @return A data frame
#' @export
#'
#' @examples
#' \dontrun{
#' poke.filter(pokeframe, "jigglypuff")
#' poke.filter(pokeframe, c("pikachu", "bulbasaur", "charmander", "squirtle"))
#' }

poke.filter <- function(pokeframe, vec){
  if (is.data.frame(pokeframe)){
    # Checks if the passed in pokeframe is a data frame
    pokeFilter <- subset(pokeframe, pokemon %in% vec)
    if (nrow(pokeFilter) > 0){
      # Checks if any of the pokem  on to be filtered for were in the passed in pokeframe
      if (nrow(pokeFilter) == length(vec)){
        # Returns the filtered dataframe if all pokemon passed in were found
        pokeFilter
      } else{
        # Notifies the user if any pokemon were not found and returns the dataframe of the pokemon that were found
        print("Some of the requested pokemon were not generation 1, the generation 1 pokemon are listed below")
        pokeFilter
      }
    } else{
      # If none of the desired pokemon were found
      if (length(vec)>1){
        # If the filter was for more than 1 pokemon
        print("Requested pokemon are not from generation 1")
      } else{
        # If the filter was for 1 pokemon
        print("Requested pokemon is not from generation 1")
      }
    }
  } else{
    # If the passed in pokeframe isn't a data frame
    print("pokeframe must be a data frame")
  }
}