README.md

In yougov-datascience/ygresults: Convenience functions to access precinct results in a REST API.

ygresults

Functions to download precinct results from YG API

Installation

devtools::install_github('yougov-datascience/ygresults')

Required options:

options(results_api_key = <your api key>,
        results_api_url = <your api base url>)

Optional Parameters:

All listed as their defaults

options(parallel_unpacking = TRUE, # controls whether unpacking is completed in parallel (windows machines may have issues with this)
        parallel_packing = TRUE, # controls whether packing for upload is done in parallel
        parallel_download = TRUE # controls whether requests for multiple counties are executed simultaneously or serially
        )

Usage:

df <- results_get("test_20180828", county = "04019")

Returns a ?tibble::tibble, in 'tidy' (read: long) format.

yougov-datascience/ygresults documentation built on May 13, 2019, 4:09 a.m.