R/data.R

In USFWS/migbirdHarvestData: Process USFWS Migratory Bird Harvest Information Program Data in R

#' Miniature fake HIP data
#'
#' Miniature fake HIP data generated by \code{data-raw/create_fake_HIP_data.R}
#'
#' @section Fields:
#' \describe{
#'   \item{title}{Title code to indicate male or female hunter}
#'   \item{firstname}{First name}
#'   \item{middle}{Middle initial}
#'   \item{lastname}{Last name}
#'   \item{suffix}{Suffix}
#'   \item{address}{Street or PO Box address}
#'   \item{city}{City of residence}
#'   \item{state}{State of residence}
#'   \item{zip}{Zip code}
#'   \item{birth_date}{Birth date}
#'   \item{issue_date}{HIP registration date}
#'   \item{hunt_mig_birds}{Code to indicate if hunter hunted migratory birds
#'   last season}
#'   \item{ducks_bag}{Code to indicate duck harvest from last season}
#'   \item{geese_bag}{Code to indicate goose harvest from last season}
#'   \item{dove_bag}{Code to indicate dove harvest from last season}
#'   \item{woodcock_bag}{Code to indicate woodcock harvest from last season}
#'   \item{coots_snipe}{Code to indicate coot and snipe harvest from last
#'   season}
#'   \item{rails_gallinules}{Code to indicate rail and gallinule harvest from
#'   last season}
#'   \item{cranes}{Code to indicate crane harvest from last season}
#'   \item{band_tailed_pigeon}{Code to indicate band-tailed pigeon harvest from
#'   last season}
#'   \item{brant}{Code to indicate brant harvest from last season}
#'   \item{seaducks}{Code to indicate sea duck harvest from last season}
#'   \item{registration_yr}{Beginning year of the hunting season that HIP
#'   registration is valid for}
#'   \item{email}{Email address}
#'   \item{dl_state}{HIP registration state}
#'   \item{dl_date}{Date of HIP file}
#'   \item{source_file}{File name that the record is from}
#'   \item{dl_cycle}{Download cycle}
#'   \item{dl_key}{Key for dl_state and dl_date combination}
#'   \item{record_key}{Key for each record}
#' }
"DF_TEST_MINI"

#' Tiny fake HIP data, as if it were read in by read_hip()
#'
#' Tiny fake HIP data generated by \code{data-raw/create_fake_HIP_data.R}
#'
#' @inheritSection DF_TEST_MINI Fields
"DF_TEST_TINI_READ"

#' Tiny fake HIP data, partially processed by clean()
#'
#' Tiny fake HIP data generated by \code{data-raw/create_fake_HIP_data.R} and
#' processed by \code{\link{clean}}
#'
#' @inheritSection DF_TEST_MINI Fields
"DF_TEST_TINI_CLEANED"

#' Tiny fake HIP data, partially processed by issueCheck()
#'
#' Tiny fake HIP data generated by \code{data-raw/create_fake_HIP_data.R} and
#' processed by \code{\link{issueCheck}}
#'
#' @inheritSection DF_TEST_MINI Fields
"DF_TEST_TINI_CURRENT"

#' Tiny fake HIP data, partially processed by duplicateFix()
#'
#' Tiny fake HIP data generated by \code{data-raw/create_fake_HIP_data.R} and
#' processed by \code{\link{duplicateFix}}
#'
#' @inheritSection DF_TEST_MINI Fields
#' @section Fields added by duplicateFix:
#' \describe{
#'   \item{record_type}{Type of record (permit or HIP registration)}
#'  }
"DF_TEST_TINI_DEDUPED"

#' Tiny fake HIP data, partially processed by proof()
#'
#' Tiny fake HIP data generated by \code{data-raw/create_fake_HIP_data.R} and
#' processed by \code{\link{proof}}
#'
#' @inheritSection DF_TEST_MINI Fields
#' @inheritSection DF_TEST_TINI_DEDUPED Fields added by duplicateFix
#' @section Fields added by proof:
#' \describe{
#'   \item{errors}{Errors within the record}
#'  }
"DF_TEST_TINI_PROOFED"

#' Tiny fake HIP data, partially processed by correct()
#'
#' Tiny fake HIP data generated by \code{data-raw/create_fake_HIP_data.R} and
#' processed by \code{\link{correct}}
#'
#' @inheritSection DF_TEST_MINI Fields
#' @inheritSection DF_TEST_TINI_DEDUPED Fields added by duplicateFix
#' @inheritSection DF_TEST_TINI_PROOFED Fields added by proof
"DF_TEST_TINI_CORRECTED"