Skip to content

954 create helper function to auto populate the saltfresh column in tada criteria and methodologies template for users - #1010

Open
hillarymarler wants to merge 6 commits into
developfrom
954-create-helper-function-to-auto-populate-the-saltfresh-column-in-tada-criteria-and-methodologies-template-for-users
Open

954 create helper function to auto populate the saltfresh column in tada criteria and methodologies template for users#1010
hillarymarler wants to merge 6 commits into
developfrom
954-create-helper-function-to-auto-populate-the-saltfresh-column-in-tada-criteria-and-methodologies-template-for-users

Conversation

@hillarymarler

@hillarymarler hillarymarler commented Aug 11, 2026

Copy link
Copy Markdown
Collaborator

Closes #954

Adds TADA_SaltFreshIndicator which populates the TADA.SaltFreshIndicator column to support mod 2 workflow and provide salt/fresh info for criteria in Mod 3.

This function will be added to an expanded Mod 2 vignette update in the near future.

This PR adds:

  1. TADA_SaltFreshIndicator function
  2. tests for the new function2
  3. Csv files in extdata to support crosswalking of salt/fresh indicator to ATTAINS.WaterType and TADA.MonitoringLocationIdentifierTypeName

Reviewing the reference table I added to crosswalk to the saltfresh indicator by water type as well as the funciton itself would be helpful. I really was not sure what to to with estuaries - should they get their own indicator value?

Pull Request Checklist (convert PR to draft if in progress)

Required

  • Update your branch from the latest develop and resolve any merge conflicts

  • Run devtools::test(), devtools::check(), and devtools::document() locally; ensure tests pass and fix any errors, warnings, or notes. Add new dependencies to DESCRIPTION and document appropriately

  • Add/update vignettes for corresponding changes in functionality, list these under articles in _pkgdown.yml, and ensure added/updated vignettes run and build with proper formatting locally

  • Request review from at least one developer team member (convert PR to ready for review if it was designated as in progress)

Best practices

  • Include a summary of the changes made and relevant context/motivation

  • Link issues to auto-close on merge (use Development sidebar or include "Closes #" in the PR)

  • Refresh inline/block comments for clarity

  • Update roxygen docs and include examples; review help pages

  • Add/update tests in tests/testthat; review the bot's coverage report from test-coverage and confirm all changes are covered

Conditional

  • If there is a bot spelling comment, run spelling::spell_check_package() locally and fix any misspellings; add approved project terms to WORDLIST with spelling::update_wordlist()

  • If tests fail suggesting internal reference files need a refresh, run .TADA_UpdateRefFiles() and .TADA_UpdateExampleData() locally via MaintenanceScheduled.R or trigger the Component File Update GitHub Action

  • If new example data files were added, document them in ExampleData.R and include them in MaintenanceScheduled.R for regular refresh

  • If columns were added/updated, update RequiredCols.R

  • If changes affect other package or the shiny app functions, update those impacted functions accordingly

@github-actions

Copy link
Copy Markdown
Contributor

Spelling check failed. Details:

Spelling check failed. Found 1 potential misspelling(s). Note: Run spelling::spell_check_package() locally and fix any misspellings; add approved project terms to WORDLIST with spelling::update_wordlist().

  WORD                 FOUND IN
SaltFreshIndicator   TADA_SaltFreshIndicator.Rd:28

@github-actions

Copy link
Copy Markdown
Contributor

Spelling check failed. Details:

Spelling check failed. Found 1 potential misspelling(s). Note: Run spelling::spell_check_package() locally and fix any misspellings; add approved project terms to WORDLIST with spelling::update_wordlist().

  WORD                 FOUND IN
SaltFreshIndicator   TADA_SaltFreshIndicator.Rd:28

…sh-column-in-tada-criteria-and-methodologies-template-for-users' of https://github.com/USEPA/EPATADA into 954-create-helper-function-to-auto-populate-the-saltfresh-column-in-tada-criteria-and-methodologies-template-for-users
@github-actions

Copy link
Copy Markdown
Contributor

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Create helper function to auto-populate the "SaltFresh" column in TADA Criteria and Methodologies template for users

1 participant