Merge pull request #2 from npaterno/master

Moving data set and documentation from openintro package to usdata package

Author: mine-cetinkaya-rundel

DESCRIPTION

@@ -17,7 +17,7 @@ License: GPL-3
 Encoding: UTF-8
 LazyData: true
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.1.0
+RoxygenNote: 7.1.1
 URL: https://github.com/OpenIntroStat/usdata
 BugReports: https://github.com/OpenIntroStat/usdata/issues
 Suggests: 

R/data-voter_count.R

@@ -0,0 +1,31 @@
+#' US Voter Turnout Data.
+#'
+#' State-level data on federal elections held in November
+#' between 1980 and 2014.
+#'
+#' @format A data frame with 936 rows and 7 variables.
+#' \describe{
+#'   \item{year}{Year election was held.}
+#'   \item{region}{Specifies if data is state or national total.}
+#'   \item{voting_eligible_population}{Number of citizens eligible to vote; does not count felons.}
+#'   \item{total_ballots_counted}{Number of ballots cast.}
+#'   \item{highest_office}{Number of ballots that contained a vote for the highest office of that election.}
+#'   \item{percent_total_ballots_counted}{Overall voter turnout percentage.}
+#'   \item{percent_highest_office}{Highest office voter turnout percentage.}
+#' }
+#'
+#' @examples
+#'
+#' library(ggplot2)
+#'
+#' ggplot(voter_count, aes(x = percent_highest_office, y = percent_total_ballots_counted)) +
+#'   geom_point() +
+#'   labs(
+#'     title = "Total Ballots V Highest Office",
+#'     x = "Highest Office",
+#'     y = "Total Ballots"
+#'   )
+#'
+#' @source \href{http://www.electproject.org/home/voter-turnout/voter-turnout-data}{United States Election Project}
+#'
+"voter_count"

_pkgdown.yml

@@ -27,6 +27,7 @@ reference:
   - state_stats
   - urban_rural_pop
   - vote_nsa
+  - voter_count
 
 - title: Functions
   contents:

data-raw/voter_count/november_voter_turnout.csv

@@ -0,0 +1,17 @@
+# load packages ----------------------------------------------------------------
+
+library(readr)
+library(usethis)
+library(here)
+
+# load data --------------------------------------------------------------------
+
+voter_count <- read_csv(here::here("data-raw/voter_count", "november_voter_turnout.csv"))
+
+# clean data: Change incorrect 0's values to NA --------------------------------
+
+voter_count[voter_count == 0] <- NA
+
+# save -------------------------------------------------------------------------
+
+usethis::use_data(voter_count, overwrite= TRUE)