pocr: POC Data and Analysis Package

###############################################################################
## data_docs.R

# This is an alphabetized collection of roxygen code to create documentation 
# for pocr data objects. 

# All built-in pocr data objects should be defined and described here.

###############################################################################

#' @title poc_colors
#' @description Vector of 4 hex colors from POC theme.
#' @docType data
#' @name poc_colors
"poc_colors"

#' @title portal_colors
#' @description Vector of 12 hex colors used in the portal
#' @docType data
#' @name portal_colors
"portal_colors"

#' @title Key to \code{quickfacts}
#' @description Verbose descriptions of \code{quickfacts} columns.
#' @docType data
#' @name qf_dict
"qf_dict"

#' @title quickfacts (from US Census Bureau)
#' @description Data frame characteristics of each county and of the state. 
#' \code{qf_dict} has the column keys.
#' @docType data
#' @name quickfacts
"quickfacts"

#' @title ref_lookup_county (from test_annie)
#' @description Data frame with columns for the county_cd, the text county, the 
#' regional code cd_region, the old regional code old_region_cd along with the 
#' old_region description old_region_desc and FIPS code countyfips. Taken from 
#' SQL Server table of the same name. I've ordered the entries so that row 
#' number corresponds to county_cd for the actual counties 1:39.
#' @docType data
#' @name ref_lookup_county
"ref_lookup_county"

#' @title ref_lookup_county_region (from test_annie)
#' @description Data frame with columns for the county_cd, the text county
#' and the regional code cd_region. Taken from SQL Server table of the same 
#' name. I've ordered the entries so that row number corresponds to county_cd 
#' for the actual counties 1:39. Additionally, has columns for region, the
#' most useful of which are probably region_6_cd, region_6_tx, and small_fl.
#' @docType data
#' @name ref_lookup_county_region
"ref_lookup_county_region"

#' @title ref_lookup_gender(from test_annie)
#' @description Data frame with columns for pk_gnder, cd_gndr and tx_gndr.
#' @docType data
#' @name ref_lookup_gender
"ref_lookup_gender"

#' @title ref_lookup_office (from test_annie)
#' @description Data frame with columns cd_office, tx_office, 
#' cd_office_county_grp, and tx_office_county_grp. Taken from SQL Server table 
#' of the same name.
#' @docType data
#' @name ref_lookup_office
"ref_lookup_office"

#' @title "ref_lookup_raceeth_census" (from test_annie)
#' @description Data frame with columns for cd_race_census and tx_race_census.
#' @docType data
#' @name "ref_lookup_raceeth_census"
"ref_lookup_raceeth_census"