R/data.R

In gunsales: Statistical Analysis of Monthly Background Checks of Gun Purchases

## run from root directory against source (installed=FALSE) or installed directory
.rawDataToSavedData <- function(installed=FALSE) {
    if (installed) {
        alldata <- read.csv(system.file("rawdata", "ncis_bystate_bymonth_bytype.csv", package="gunsales"), na = "#N/A", stringsAsFactors=FALSE)
        poptotal <- read.csv(system.file("rawdata", "population.csv", package="gunsales"), stringsAsFactors=FALSE)
    } else {                          
        alldata <- read.csv("inst/rawdata/ncis_bystate_bymonth_bytype.csv", na = "#N/A", stringsAsFactors=FALSE)
        poptotal <- read.csv("inst/rawdata/population.csv", stringsAsFactors=FALSE)
    }
    save(alldata, file="data/alldata.RData", compress="xz", compression_level=9)    
    save(poptotal, file="data/poptotal.RData", compress="xz", compression_level=9)
}

#' Source data from the FBI's National Instant Criminal Background Check System
#'
#' It was converted from the original PDF format to CSV using Tabula.
#'
#' @docType data
#' @name alldata
#' @format A \sQuote{tbl_df} and data frame object with 11480 observation of 34 variables
#' @source \url{https://www.fbi.gov/file-repository/nics_firearm_checks_-_month_year_by_state_type.pdf}
#' @seealso The GitHub repository created by Buzzfeed containing a similar data set
#' at \url{https://github.com/BuzzFeedNews/nics-firearm-background-checks/}
NULL

#' US Population Growth data
#'
#' Montly observations about population growth
#'
#' @docType data
#' @name poptotal
#' @format A \sQuote{tbl_df} and data frame object with 217 observation of 3 variables
#' @source US Census Bureau 
NULL