Enhancing filter functions #54
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…eritParams, added run-able framrosetta examples
Ty-WDFW
approved these changes
Dec 13, 2024
|
closes #53 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed solution to #53
Added optional
speciesargument to each filter function. User can provide "CHINOOK" or "COHO" to allow the use of .data objects that do not contain aspeciesattribute. Ifspeciesis provided, but data is provided that contains aspeciesattribute which conflicts, functions produce an informative error.Roxygen code for documentation descriptions now use
@inheritParamsto avoid repetitive updates of parameter descriptions.Each filter function now has to run examples, filtering the coho and chinook fisheries tables from the
{framrosetta}package.