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

Flag column values are inconsistent (Rejected, Invalid, Suspect vs. Accepted, Valid, Pass) #515

Open
8 tasks
cristinamullin opened this issue Aug 23, 2024 · 2 comments
Assignees

Comments

@cristinamullin
Copy link
Collaborator

Is your feature request related to a problem? Please describe:

Flag function outputs are still inconsistent (three variations of each). It would be more user friendly if they all used the same flag names (e.g., Rejected, Invalid, Suspect vs. Accepted, Valid, Pass).

The following flag columns and their associated functions are relevant to this issue:

  • TADA.SampleFraction.Flag
  • TADA.MethodSpeciation.Flag
  • TADA.ResultUnit.Flag
  • TADA.ResultValueAboveUpperThreshold.Flag
  • TADA.ResultValueBelowLowerThreshold.Flag
  • TADA.AnalyticalMethod.Flag
  • TADA.MeasureQualifierCode.Flag

Describe the solution you'd like:

Suggest to use Suspect and Pass for consistency.

Reminders for TADA contributors addressing this issue:

New features and/or edits should include all the following work:

  • Create or edit the function/code.

  • Document all code using line/inline and/or multi-line/block comments
    to describe what is does.

  • Create or edit tests in tests/testthat folder to help prevent and/or
    troubleshoot potential future issues.

  • Create or edit the function documentation. Include working
    examples.

  • Update or add the new functionality to the appropriate vignette
    (or create new one).

  • If function/code edits made as part of this issue impact other
    functions in the package or functionality in the shiny app, ensure
    those are updated as well.

  • Run TADA_UpdateAllRefs(), TADA_UpdateExampleData(), styler::style_pkg(),
    devtools::document(), and devtools::check() and address any new notes or
    issues before creating a pull request.

  • Run more robust check for releases: devtools::check(manual = TRUE,
    remote = TRUE, incoming = TRUE)

@wokenny13 wokenny13 self-assigned this Aug 23, 2024
@wokenny13
Copy link
Collaborator

Is it best to create a function that can addressing consistent flagging of column values? Or make a decision to handle them manually?

*'Suspect' and 'Pass' for consistency is suggested

@hillarymarler did we ever address the flagging consistency with WY/MT? We might need to notify them of this update to their documentation of the WQP/TADA tool they've been working on once this issue has been addressed?

@hillarymarler
Copy link
Collaborator

@wokenny13 - we will definitely want to communicate with them as we make updates. Also, with the team that is working on a similar tool for AK.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants