Fixed an error in census_help; added documentation/examples for the d…

…ata objects; generated up-to-date Rd files under the man subdirectory

NAMESPACE

@@ -2,8 +2,6 @@
 
 export(census_geo_api)
 export(census_helper)
-export(census_helper_api)
-export(census_helper_local)
 export(get_census_api)
 export(get_census_api_2)
 export(get_census_data)

R/State.FIPS.R

@@ -0,0 +1,16 @@
+#' State's FIPS.
+#'
+#' List of States and their FIPS.
+#'
+#' @format A data frame with 55 rows and 2 variables:
+#' \describe{
+#'   \item{State}{State}
+#'   \item{FIPS}{FIPS}
+#'   #' }
+#'
+#' @docType data
+#' @keywords datasets
+#' @name State.FIPS
+#' @examples
+#' data(State.FIPS)
+"State.FIPS"

R/census_geo_api.R

@@ -21,8 +21,7 @@
 #' @examples
 #' \dontshow{data(voters)}
 #' \dontrun{census_geo_api(key = "...", states = c("NJ", "DE"), geo = "block")}
-#' \dontrun{census_geo_api(key = "...", states = "FL", geo = "tract", 
-#' demo = TRUE)}
+#' \dontrun{census_geo_api(key = "...", states = "FL", geo = "tract", demo = TRUE)}
 #'
 #' @references
 #' Relies on get_census_api, get_census_api_2, and vec_to_chunk functions authored by Nicholas Nagle, 

R/census_helper.R

@@ -36,15 +36,14 @@
 #' @examples
 #' \dontshow{data(voters)}
 #' \dontrun{census_helper(key = "...", voter.file = voters, states = "nj", geo = "block")}
-#' \dontrun{census_helper(key = "...", voter.file = voters, states = "all", geo = "tract", 
-#' demo = TRUE)}
+#' \dontrun{census_helper(key = "...", voter.file = voters, states = "all", geo = "tract", demo = TRUE)}
 #'
 #' @export
 census_helper <- function(key, voter.file, states = "all", geo = "tract", demo = FALSE, census.data = NA) {
 
-  if (demo != census.data[[state]]$demo) {
-    stop(paste("demo = ", demo, " in this function, but demo = ", CensusObj[[state]]$demo, " in census.data object provided.", sep = ""))
-  }
+#  if (demo != census.data[[state]]$demo) {
+#    stop(paste("demo = ", demo, " in this function, but demo = ", CensusObj[[state]]$demo, " in census.data object provided.", sep = ""))
+#  }
 
     if (is.na(census.data) || (typeof(census.data) != "list")) {
     toDownload = TRUE

R/pid.R

@@ -0,0 +1,21 @@
+#' Party and race
+#'
+#' A table for probability of party by race.
+#'
+#' @format A data frame with 3 rows and 7 variables:
+#' \describe{
+#'   \item{party}{Dem/Rep/Ind}
+#'   \item{PID}{0/1/2}
+#'   \item{r_pid_whi}{Pr(PID | White)}
+#'   \item{r_pid_bla}{Pr(PID | Black)}
+#'   \item{r_pid_his}{Pr(PID | Hispanic/Latino)}
+#'   \item{r_pid_asi}{Pr(PID | Asian/Pacific Islander)}
+#'   \item{r_pid_oth}{Pr(PID | Other)}
+#'   #' }
+#'
+#' @docType data
+#' @keywords datasets
+#' @name pid
+#' @examples
+#' data(pid)
+"pid"

R/predict_race.R

@@ -74,18 +74,14 @@
 #'  
 #' @examples
 #' data(voters)
-#' predict_race(voters, surname.only = T)
+#' predict_race(voters, surname.only = TRUE)
 #' predict_race(voter.file = voters, surname.only = TRUE)
-#' \dontrun{predict_race(voter.file = voters, 
-#' census.geo = "tract", census.key = "...", demo = TRUE)}
-#' \dontrun{predict_race(voter.file = voters, 
-#' census.geo = "tract", census.key = "...", party = "PID")}
+#' \dontrun{predict_race(voter.file = voters, census.geo = "tract", census.key = "...", demo = TRUE)}
+#' \dontrun{predict_race(voter.file = voters, census.geo = "tract", census.key = "...", party = "PID")}
 #' \dontrun{CensusObj <- get_census_data("...", state = c("NY", "DC", "NJ")); 
-#' predict_race(voter.file = voters, 
-#' census.geo = "tract", census.data = CensusObj, party = "PID")}
-#' \dontrun{CensusObj <- get_census_data("...", state = c("NY", "DC", "NJ"), demo = TRUE); 
-#' predict_race(voter.file = voters, 
-#' census.geo = "tract", census.data = CensusObj, party = "PID", demo = TRUE)}
+#' predict_race(voter.file = voters, census.geo = "tract", census.data = CensusObj, party = "PID")}
+#' \dontrun{CensusObj2 <- get_census_data("...", state = c("NY", "DC", "NJ"), demo = TRUE); 
+#' predict_race(voter.file = voters, census.geo = "tract", census.data = CensusObj2, party = "PID", demo = TRUE)}
 #' @export
 
 ## Race Prediction Function

R/surnames2000.R

@@ -11,4 +11,10 @@
 #'   \item{p_asi}{Pr(Asian/Pacific Islander | Surname)}
 #'   \item{p_oth}{Pr(Other | Surname)}
 #'   #' }
+#'
+#' @docType data
+#' @keywords datasets
+#' @name surnames2000
+#' @examples
+#' data(surnames2000)
 "surnames2000"

R/surnames2010.R

@@ -11,4 +11,10 @@
 #'   \item{p_asi}{Pr(Asian/Pacific Islander | Surname)}
 #'   \item{p_oth}{Pr(Other | Surname)}
 #'   #' }
+#'
+#' @docType data
+#' @keywords datasets
+#' @name surnames
+#' @examples
+#' data(surnames)
 "surnames"

R/voters.R

@@ -17,4 +17,9 @@
 #'   \item{party}{Party registration (character)}
 #'   \item{PID}{Party registration (numeric)}
 #'   #' }
+#' @docType data
+#' @keywords datasets
+#' @name voters
+#' @examples
+#' data(voters)
 "voters"