-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathREADME.Rmd
67 lines (50 loc) · 3.06 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# migbirdHS <img width=150px src="man/figures/logo.svg" align="right" />
## Overview
The migbirdHS package provides an easy-to-use set of R functions for the U.S. Fish and Wildlife Service Migratory Bird Program to process online [Harvest Survey](https://www.fws.gov/harvestsurvey) data.
Tasks that can be accomplished with this package include:
* `read_dhs` imports data
* `add_seaducks` appends seaduck season info to the reference table
* `refcheck` double checks the reference table covers all cases
* `submitted` reports proportion of non-finalized hunts
* `hunted` reports proportion of hunters who did not hunt
* `nodata` checks for any missing data that was expected
* `partyhunt` checks for group hunts
* `overdays` checks if number of days hunted exceeds hunting season
* `overbags` checks for abnormally high bag sizes
* `openclose` checks to see if harvest date falls outside the season
* `huntdays` summarizes the total number of days hunted
* `retrieved` summarizes the total number of bids retrieved
* `retrievedmap` maps the mean retrieved per state and species
* `responselag` visualizes time between hunt date and response date
* `bagdays` summarizes days hunted per hunter and species group
* `bagspp` summarizes species hunted by popularity
* `compare` visualizes differences between daily and season data
* `partyproof` divides retrieved birds by party size, when needed
* `proofHS` looks for and flags errors in daily and season data
* Automated report writing with `reportHS`
## Installation
```r
devtools::install_github("USFWS/migbirdHS", build_vignettes = T, upgrade = F, quiet = T)
```
## Vignette
``` r
vignette(topic = "migbirdHS_workflow", package = "migbirdHS")
```
## Function Flow
<img src="vignettes/image/migbirdHS_flow_chart.svg" title="Overview of migbirdHS functions in a flowchart format." alt="Overview of migbirdHS functions in a flowchart format." width="100%" style="display: block; margin: auto;" />
## 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](https://creativecommons.org/publicdomain/zero/1.0/) license.