Skip to contents

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
  • bagCheck identifies any new or unexpected bag values
  • issueCheck looks for records that should be processed later
  • duplicateFinder identifies duplicate HIP records
  • duplicateFix resolves duplicate HIP records
  • proof checks values for errors
  • correct systematically fixes erroneous values
  • Error visualization with errorPlotDL, errorPlotFields, and errorPlotStates
  • Detailed error table reporting with errorTable and pullErrors
  • Automated report writing with writeReport
  • Custom .csv writing with write_hip

Installation 

pak::pak("USFWS/migbirdHIP")

Releases

Below are the definitive package versions used for each hunting season. To install a past release, use the example below and substitute the appropriate version number.

pak::pak("USFWS/migbirdHIP@v1.2.8")

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.