R package that provides an interactive and reproducible workflow for creating and reporting in-season harvest and effort estimates for the Lower Kuskokwim River subsistence salmon fisheries.
The intent is to convert a process that was previously driven by "copy, paste, edit, repeat" on code files into one that is menu-driven, intuitive, and automated. Importantly, it requires no code-editing to create estimates and standardized reports.
To use 'KuskoHarvEst', you will need to first download several programs, install them, and install some packages (extensions) of these programs. It is essential that you perform these tasks in the order described below.
NOTE: If you already have R and RStudio, but they were installed later than in the last ~6-12 months, it is advised that you uninstall the older versions and install the newest versions.
If not updating, ensure you have at least R v4.1.0 or later.
- Program R: this is the program that runs the code, but the interface is entirely code-based and not easy to work with.
- RStudio Desktop: this is a program that makes working with R much easier, and allows construction of custom interactive interfaces (drop down menus, text entry boxes, etc.).
After downloading the programs, you must install them. You may need administrative privileges to do this - if so and you do not have them, contact your organization's Information Technology specialist for help (you will not need administrative privileges for any other steps). During the installation process, you will be presented with several options - you can accept the default options in all cases.
Once you have installed RStudio, open it, paste the code below in the console and press ENTER. This will install nearly everything you need to create harvest estimates. Many additional R packages will be installed automatically.
install.packages("remotes")
remotes::install_github("bstaton1/KuskoHarvEst")KuskoHarvEst:::install_TeX()If you have done this step previously, you may be asked to enter Y/N (yes/no) whether to re-install (Y recommended).
There is one more thing that will make your life easier.
RStudio by default will save files you do not ever need: .Rdata and .Rhistory.
In my opinion, they do nothing but create clutter. You can prevent RStudio from saving them by following these steps:
First, navigate to the "Tools" menu in RStudio, then select "Global Options":
Then, make sure your settings look just like the highlighted ones below, and click "Apply" and "OK":
You will interact with intuitive menu-driven interfaces provided by KuskoHarvEst' to create documents that summarize the data and results of harvest estimation for a given harvest opportunity. Your workflow for a given opportunity will be:
- Gather the raw data files and ensure all data appear reasonable and files are formatted properly*
- Create a new R project and include the raw data files within it
- Enter the "meta-data" for the opportunity (date/times, gear types allowed, etc.)
- Process the raw data files into a standardized format, which includes automated screening of interview data for potentially unreliable information
- Produce the reports (one for the main summary and one for sensitivity analyses), which are automatically populated with the inputs and outputs of each analysis
This means the only things you will edit directly are either (a) in the data files or (b) contained in a straight-forward interface. In step (4), you may find some data entry problems. If that is the case, simply close the interface and edit the raw data to correct the problem, and start step (4) over.
*Improperly formatted/entered data will be the number one cause of errors you see (hopefully you see none!), so pay extra care to this topic.
It is recommended that you review the documentation for 'KuskoHarvEst' before using it. Lots of information is available through the built-in "Help" tool, available through the "Addins" menu at the top of RStudio:
There are dedicated documents with step-by-step instructions and general guidance on how to use each interactive tool and more, accessible through this menu in the 'KuskoHarvEst' help tool:
Additionally, users can find example data files to illustrate precisely how the individual raw data files should be formatted. These are accessible through this menu in the 'KuskoHarvEst' help tool:
Users new to in-season Kuskokwim River subsistence harvest monitoring and estimation are advised to read the Staton (2018) report - it details the data collection and analytical methods. This is accessible by clicking the link in this section of the 'KuskoHarvEst' help tool:
Finally, users can find some information about the 'KuskoHarvEst' development project in the project summary report:
'KuskoHarvEst' is a member of a family of packages:
- 'KuskoHarvData' stores the data and compiled estimates across multiple openers and years.
- 'KuskoHarvPred' contains tools for predicting outcomes of future openers based on past data.
- 'KuskoHarvUtils' contains features that support the other packages.
A description of the sampling methodology and estimation framework can be found in the manuscript:
In-season monitoring of harvest and effort from a large-scale subsistence salmon fishery in western Alaska by B. A. Staton, W. R. Bechtol, L. G. Coggins Jr., G. Decossas, and J. Esquible, submitted to the Canadian Journal of Fisheries and Aquatic Sciences (analysis repository: bstaton1/KuskoHarvEst-ms-analysis; archived under DOI 10.5281/zenodo.10369148).
An approach for predicting outcomes of future openers based on past data can be found in the manuscript:
In-season predictions of daily harvest for lower Kuskokwim River subsistence salmon fisheries by B. A. Staton, W. R. Bechtol, L. G. Coggins Jr., and G. Decossas, submitted to the North American Journal of Fisheries Management (analysis repository: bstaton1/KuskoHarvPred-ms-analysis; archived under DOI 10.5281/zenodo.13293677).
If users are uncertain with how to properly use an aspect of the tool and cannot find the answer in the documentation, they are encouraged to contact the developer of the software: Ben Staton (bstaton.qes@gmail.com).
The developer should also be contacted in the event of a major change to the sampling protocol. 'KuskoHarvEst' relies on specific sampling characteristics (specifically, that sampling is conducted similarly to the 2016-2021 seasons) and some sampling changes may lead to incompatibility with 'KuskoHarvEst' or cause it to produce unreliable output.
Several people provided valuable feedback on the functionality included in this package, in alphabetical order they are: B. Bechtol, G. Decossas, J. Esquible, D. Lowrey, J. Spaeder, K. Russell, and K. Whitworth. L. Coggins co-developed the statistical foundations of the harvest/effort estimators with B. Staton starting in 2016, with earlier work done in 2015. The graphic of the fisher in the 'KuskoHarvEst' package logo was created by N. Tamburello.
This package is totally reliant on RStudio Desktop, Rmarkdown, and Shiny to do its job. The developers of these free software products are owed gratitude for making the construction of intuitive workflows like those contained in 'KuskoHarvEst' possible.
Funding for the development of this package was provided by the Kuskokwim River Inter-Tribal Fish Commission, administered by the Bering Sea Fisherman's Association through grant #AC-2101 to Quantitative Ecological Services, LLC for the project period January and October, 2021. The initial development of the statistical and reporting framework, off of which 'KuskoHarvEst' is based, was funded by the U.S. Fish and Wildlife Service through a Pathways Position during the summers of 2016-2018.