Skip to content

Latest commit

 

History

History
70 lines (54 loc) · 2.68 KB

README.md

File metadata and controls

70 lines (54 loc) · 2.68 KB
Raw

migbirdHIP

Overview

The migbirdHIP package provides a set of R functions for the U.S. Fish and Wildlife Service Migratory Bird Program to process, clean, and visualize Harvest Information Program data.

Tasks that can be accomplished with this package include:

  • read_hip imports data
  • clean does basic reorganization tasks
  • fileCheck makes sure all files are new
  • glyphCheck identifies non-UTF-8 characters
  • shiftCheck finds line shift errors
  • strataCheck identifies any new or unexpected strata
  • validate checks for table-wide repetition
  • identicalBags checks for matching columns within files
  • issueCheck looks for records that should be processed later
  • findDuplicates identifies duplicate HIP records
  • fixDuplicates resolves duplicate HIP records
  • proof checks values for errors
  • correct systematically fixes erroneous values
  • Error visualization with errorPlot_dl, errorPlot_fields, and errorPlot_states
  • Exploration of specific errors with youthHunters and outOfStateHunters
  • Detailed error reporting with errorTable, pullErrors, and redFlags
  • Automated report writing with writeReport
  • Custom .csv writing with write_hip

Installation

devtools::install_github("USFWS/migbirdHIP", build_vignettes = T)

Vignette

vignette(topic = "migbirdHIP_workflow", package = "migbirdHIP")

Function Flow

Overview of migbirdHIP functions in a flowchart format.

USFWS Disclaimer

The United States Fish and Wildlife Service (FWS) GitHub project code is provided on an “as is” basis and the user assumes responsibility for its use. FWS has relinquished control of the information and no longer has responsibility to protect the integrity, confidentiality, or availability of the information. Any reference to specific commercial products, processes, or services by service mark, trademark, manufacturer, or otherwise, does not constitute or imply their endorsement, recommendation or favoring by FWS. The FWS seal and logo shall not be used in any manner to imply endorsement of any commercial product or activity by FWS or the United States Government.

License

This project is licensed under the terms of the Creative Commons Zero v1.0 Universal license.