R/setup_botscan.R

In kurtawirth/botscan: Scans Twitter Conversations For Bots

#' setup_botscan
#'
#' Initialize Keys, Tokens, and Secrets for Twitter Access
#'
#' Takes a Twitter query and produces the percentage of users within that
#' conversation that are likely to be bots.
#'
#' @author Ryan T. Moore
#'
#' @param rapidapi_key A string representing the RapidAPI key
#' 
#' @param consumer_key A string representing the consumer key
#' 
#' @param consumer_secret A string representing the consumer secret
#' 
#' @param access_token A string representing the access token
#' 
#' @param access_token_secret A string representing the access token secret
#' 
#' @return A list of length two with components
#' \item{rapidapi_key}{The RapidAPI key}
#' \item{twitter_app_auth}{A list of length four, including the consumer_key, 
#' consumer_secret, access_token, and access_token_secret}
#'
#' @examples
#' \dontrun{bom <- setup_botscan("a", "b", "c", "d", "e")}
#' 
#' # The above example fails, since each key, secret, or token must be created
#' # by the user via ...
#' 
#' @export

setup_botscan <- function(rapidapi_key, consumer_key, consumer_secret, 
                          access_token, access_token_secret){
  
  twitter_app_auth <- list(consumer_key = consumer_key,
                           consumer_secret = consumer_secret,
                           access_token = access_token,
                           access_token_secret = access_token_secret)
  
  python_file_path <- system.file("python", "create_bom.py", package = "botscan")
              
  reticulate::source_python(python_file_path)
  
  bom <- create_bom(rapidapi_key, twitter_app_auth)

  return(bom)
  
}