R/elexr.R

In ghing/elexr: Simple wrapper around the elex tool

#' @details 
#' 
#' A light R wrapper around the elex command
#'   
#' elexr provides an R interface for the elex package 
#' (http://github.com/newsdev/elex/) to load election results from the 
#' Associated Press Elections API.
#'   
#' Rather than reinventing the wheel, this package simply runs \code{elex} in
#' a shell and loads the CSV output into a data frame.  Because of this,
#' you'll need Python and to install elex by following the instructions at 
#' \url{http://elex.readthedocs.org/en/latest/install.html}.
#'   
#' You'll also need an API key for the API Elections API.  You'll need to set
#' the \code{AP_API_KEY} environtment variable in your R session to be able to
#' retreive results.
#' 
#' @examples
#' library(elexr)
#' Sys.setenv(AP_API_KEY = "YOUR_AP_ELECTIONS_API_KEY")
#' iowa_caucus_results <- results('03-01-2016')
#'   
"_PACKAGE"