R/load_data.R

Defines functions load_olympic_json_data load_olympic_csv_data

Documented in load_olympic_csv_data load_olympic_json_data

.datatable.aware <- TRUE

#' Load Olympic CSV Data
#' 
#' Given a Sport ID and Match ID, load a pre-parsed CSV of data from that event
#' @author Billy Fryer
#' @param sportID Sport ID
#' @param matchID Match ID
#' @return A data.frame
#' @importFrom data.table fread
#' @export
#' @examples 
#' \donttest{
#' load_olympic_csv_data(sportID = 113, matchID = 746587)
#' }
#' @source NBC API
load_olympic_csv_data <- function(sportID, matchID){
  
  url <- paste0("https://raw.githubusercontent.com/billyfryer/Beijing-Olympics-Data-Repo/main/Data/",
                sportID,"-CSVs/",matchID,".csv")
  
  # Read in CSV File from website
  output <- tryCatch(
    expr = {data.table::fread(url)},
    error = function(err){"Combination of sportID and matchID does not exist."}
    )
  return(output)
}

#' Load Olympic JSON Data
#' 
#' Given a Sport ID and Match ID, load the raw JSON file
#' @author Billy Fryer
#' @param sportID Sport ID
#' @param matchID Match ID
#' @return Nested Lists in the form of a JSON File
#' @importFrom jsonlite fromJSON 
#' @export
#' @examples 
#' \donttest{
#' load_olympic_json_data(sportID = 113, matchID = 746587)
#' }
#' @source NBC API
load_olympic_json_data <- function(sportID, matchID){
  
  url <- paste0("https://raw.githubusercontent.com/billyfryer/Beijing-Olympics-Data-Repo/main/Data/",
                sportID,"-JSONs/",matchID,".json")
  
  # Read in JSON File from website
  output <- tryCatch(
    expr = {jsonlite::fromJSON(url)},
    error = function(err){"Combination of sportID and matchID does not exist."}
    )
  return(output)
}
b4billy/FHSTR documentation built on June 18, 2022, 12:12 p.m.