Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Split functionality for ReportFdaSampling #156

Open
edvinf opened this issue Dec 28, 2024 · 0 comments
Open

Split functionality for ReportFdaSampling #156

edvinf opened this issue Dec 28, 2024 · 0 comments
Labels
breakCompatibility Issues or pull request that delibarately break backwards compatibility enhancement New feature or request

Comments

@edvinf
Copy link
Contributor

edvinf commented Dec 28, 2024

The output for ReportFdaSampling is structurally different depending on whether the argument 'SamplingVariables' is provided (see function documentation for ReportFdaSampling). This behaviour is by design, as users like to have one place to consult for these nearly identical outputs. But I think it was a mistake. Users will easily get confused about what total weights of the fishery is, and functions that consume this data-format have to check for which variant is passed.

Downstream functions in StoX are at the moment:
PlotSamplingCoverage
PlotSamplingOverviewCell
PlotSamplingVariables

Each of these require sampling variables to be either present or not. ReportFdaSamplingData should clearly be two data types. We should consider fixing this the next time we are deciding to break backwards compatibility.

@edvinf edvinf added enhancement New feature or request breakCompatibility Issues or pull request that delibarately break backwards compatibility labels Dec 28, 2024
@edvinf edvinf self-assigned this Dec 28, 2024
@edvinf edvinf removed their assignment Feb 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breakCompatibility Issues or pull request that delibarately break backwards compatibility enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant