Skip to contents

All functions

DF_TEST_MINI
Miniature fake HIP data
DF_TEST_TINI_CLEANED
Tiny fake HIP data, partially processed by clean()
DF_TEST_TINI_CORRECTED
Tiny fake HIP data, partially processed by correct()
DF_TEST_TINI_CURRENT
Tiny fake HIP data, partially processed by issueCheck()
DF_TEST_TINI_DEDUPED
Tiny fake HIP data, partially processed by duplicateFix()
DF_TEST_TINI_PROOFED
Tiny fake HIP data, partially processed by proof()
DF_TEST_TINI_READ
Tiny fake HIP data, as if it were read in by read_hip()
assignFlyway()
Assign flyway as new field
badDateMessage()
Return message if bad issue dates detected
bagCheck()
Check bag values
btpiPermitBagFix()
Fix band-tailed pigeon permit bag values
checkFileNameDateFormat()
Check HIP file name date formatting
checkFileNameStateAbbr()
Check HIP file name state abbreviations
clean()
Clean data
correct()
Correct data
correctEmail()
Correct email
correctMiddleInitial()
Correct middle initials
correctSuffix()
Correct suffix
correctTitle()
Correct title
cranePermitBagFix()
Fix crane permit bag values
dropBlankFiles()
Drop blank files
dropBlankLines()
Drop blank lines
duplicateAllOnes()
Flag all-one records in a group of duplicates
duplicateAllOnesGroupSize()
Evaluate group sizes of all-one/not-all-one records
duplicateDecide()
Decide which duplicate records should be kept or dropped
duplicateFields()
Find causes of duplication
duplicateFinder()
Find duplicates
duplicateFix()
Fix duplicates
duplicateID()
Create a tibble of duplicates with an ID column
duplicateNewest()
Find the most recent records out of a group of duplicates
duplicatePlot()
Plot duplicates
duplicateRecordType()
Set record type
duplicateSample()
De-duplicate by randomly sampling intermediate tibbles
errorLevelErrorsByField()
Calculate error-level errors by field
errorLevelErrorsByState()
Calculate error-level errors by state
errorPlotDL()
Plot errors across download cycles
errorPlotFields()
Plot HIP errors by field
errorPlotStates()
Plot errors by state
errorTable()
Table of errors
errorTableSummary()
Summary table of errors
failBTPI()
Fail if BTPI permit file contains bad values
failCR()
Fail if crane permit file contains bad values
failDLdate()
Fail if there is an NA in dl_date
failDLstate()
Fail if there is an NA in dl_state
failState()
Fail if bad state abbreviation supplied
failTF()
Fail if TRUE or FALSE is not supplied
failWidths()
Fail if field widths are exceeded by any value
failProofed()
Fail if non-proofed data frame supplied
failYear()
Fail if incorrect year supplied
fileCheck()
Check for repeat files
fileRename()
Raw HIP file name correction
formatZip()
Format zip codes
futureDateMessage()
Return message if future issue_date values are detected
getBadAddress()
Get bad address values
getBadBirthDate()
Get bad birth date values
getBadCity()
Get bad city values
getBadFirstName()
Get bad first name values
getBadHuntMigBirds()
Get bad hunt mig birds values
getBadLastName()
Get bad last name values
getBadMiddle()
Get bad middle initial values
getBadRegYear()
Get bad registration year values
getBadState()
Get bad state values
getBadSuffix()
Get bad suffix values
getBadTitle()
Get bad title values
getBadZIP()
Get bad zip code values
glyphCheck()
Find non-UTF-8 glyphs/characters in any field
glyphFinder()
Find non-UTF-8 glyphs/characters in a field
idBlankFiles()
Identify blank files
ignoreHolds()
Ignore hold files
ignoreLifetime()
Ignore lifetime files
ignorePermits()
Ignore permit files
inLinePermitDNHFix()
In-line permit did-not-hunt fix
inLinePermitDNHMessage()
In-line permit did-not-hunt message
interStateDuplicatesMessage()
Inter-state duplicates message
invalidDateMessage()
Return message if invalid issue_date values are detected
issueAssign()
Assign registration_yr values using issueDecide
issueCheck()
Check issue dates and license years
issueDecide()
Assign decisions to records using issue date and registration year
issueMessages()
Return messages to console for issueCheck insights
issuePlot()
Plot issue date errors
issuePlotDateLabel()
Label dates for issue date plot
issuePrint()
Print results of issueCheck changes
listFiles()
List files
missingEmailsMessage()
Return message if all emails are missing or are exactly the same in a file with more than 10 registrations
missingPIIFilter()
Missing PII filter
missingPIIMessage()
Return message for records with blank or NA values in firstname, lastname, state, or birth date
moveSuffixes()
Move suffixes
nDropped()
Summary table of how many registrations were dropped
nDroppedClean()
Summary table of how many registrations were dropped by clean
nDroppedCurrent()
Summary table of how many registrations were dropped by issueCheck
naBagsMessage()
Return message if any record has an NA in every bag field
namesToUppercase()
Names to uppercase
nonDigitBagsMessage()
Return message if any record contains a bag value that is not a 1-digit number
nonResidentMessage()
High non-resident hunter proportion message
pastDateMessage()
Return message if past issue_date values are detected
permitFileBagsMessage()
Permit file non-zero bag values message
proof()
Proof data and flag errors
proofBadEmails()
Proof bad emails
pullErrors()
Pull flagged errors
qAddress()
Bad address message
qBags()
Bad bag messages
qBirthDate()
Bad birth dates message
qBirthDateRange()
Birth date range message
qCity()
Bad city message
qFirstName()
Bad first name message
qHuntMigBirds()
Return message if records with bad values for hunt_mig_birds are detected
qIssueDateRange()
Issue date range message
qLastName()
Bad last name message
qMiddle()
Bad middle initial message
qRegistrationYear()
Bad registration_yr message
qState()
Bad state message
qSuffix()
Bad suffix message
qSummary()
Quality summary
qTitle()
Bad title message
qZIP()
Bad zip code message
qualityMessages()
Return messages to console for common or catastrophic data quality issues
questionYear()
Question if correct year supplied
readTimeMessage()
Read time message
read_hip()
Read in data
redFlags()
Pull bad data
regYearEditMessage()
Return message for changed registration_yr values
shiftCheck()
Check for frame shifts
shiftFinder()
Find frame shifts
testRecordMessage()
Return message if test record is found
timeTravelMessage()
Return message if an issue date is after the file was submitted
twoSeasonMessage()
Return message if registrations are detected from two-season overlap windows
writeReport()
Write an R markdown report from template
write_hip()
Modify corrected data table format and write as csv
zeroBagsMessage()
Return message if any record has a "0" in every bag field
zeroDateMessage()
Return message for 00/00/0000 issue_date value(s)
zipCheck()
Check if zip codes are associated with the correct state