Repository navigation
Conversation
…e-tadausesaliasrefcsv-and-start-to-review-matches-approved-or-rejected
…esaliasmethod-column-to-the-tadausesaliasrefcsv-and-start-to-review-matches-approved-or-rejected
…nly if they exist in the CST. This correctly filters by only exisiting uses for a pollutant name for an org in the final output. users will need to determine the appropriate ATTAINS.UseName to CST.UseName crosswalk from this filtered list.
Focus on just ATTAINS.UseName to CST.UseName crosswalk
… CST values still if a CST.PollutantName is found
Contributor
|
Spelling check failed. Details: |
…ions' of https://github.com/USEPA/EPATADA into 1056-incorporate-cst-pollutant-and-uses-crosswalk-functions
Collaborator
Author
|
There are many references to function name changes that would need to be done. Before I proceed making all these name changes in the package, @hillarymarler are we comfortable changing TADA_ParametersForAnalysis to TADA_CrosswalkWQPATTAINSParam and changing TADA_UsesForAnalysis to TADA_CrosswalkCSTATTAINSUse? |
…alysis throughout package
wokenny13
marked this pull request as ready for review
November 12, 2026 21:05
for more information, see https://pre-commit.ci
Contributor
|
Spelling check failed. Details: |
1 similar comment
Contributor
|
Spelling check failed. Details: |
Contributor
|
Spelling check failed. Details: |
1 similar comment
Contributor
|
Spelling check failed. Details: |
…ions' of https://github.com/USEPA/EPATADA into 1056-incorporate-cst-pollutant-and-uses-crosswalk-functions
for more information, see https://pre-commit.ci
Contributor
|
Spelling check failed. Details: |
1 similar comment
Contributor
|
Spelling check failed. Details: |
wokenny13
marked this pull request as draft
November 16, 2026 23:17
for more information, see https://pre-commit.ci
Contributor
|
Spelling check failed. Details: |
1 similar comment
Contributor
|
Spelling check failed. Details: |
This branch has not been deployed
This file contains hidden or 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
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.
Pull Request Checklist (convert PR to draft if in progress)
Future Issues that still need to addressed (will be done as a separate PR in future):
Example Workflow:
#' # First, generate and fill out a parameter crosswalk (see TADA_CrosswalkCSTWQPATTAINSParam()):
#' paramRef_UT <- TADA_CrosswalkCSTWQPATTAINSParam(
#' Data_Nutrients_UT,
#' org_id = "UTAHDWQ",
#' auto_assign = "All",
#' excel = FALSE)
#'
#' # modify the parameter crosswalk
#' paramRef_UT2 <- dplyr::mutate(paramRef_UT, ATTAINS.ParameterName = dplyr::case_when(
#' grepl("AMMONIA", TADA.ComparableDataIdentifier) ~ "AMMONIA, TOTAL",
#' grepl("NITRATE", TADA.ComparableDataIdentifier) ~ "NITRATE",
#' grepl("NITROGEN", TADA.ComparableDataIdentifier) ~ "NITRATE/NITRITE (NITRITE + NITRATE AS N)"
#' ))
#'
#' # provide the modified/saved parameter crosswalk as a user supplied one
#' paramRef_UT3 <- TADA_CrosswalkCSTWQPATTAINSParam(
#' Data_Nutrients_UT,
#' paramRef = paramRef_UT2,
#' org_id = "UTAHDWQ",
#' excel = FALSE
#' )
#'
#' # Recommended step: Modify the ATTAINS.UseName to CST.UseName crosswalk.
#' usesRef_UT <- TADA_CrosswalkCSTATTAINSUses(org_id = "UTAHDWQ", paramRef = paramRef_UT2)
#'
#' modified.useRef_UT <- dplyr::filter(
#' usesRef_UT,
#' USE_CLASS_NAME_LOCATION_ETC == "AQUATIC WILDLIFE; CLASSES 3A, 3B, 3C, 3D" &
#' (ATTAINS.UseName == "AQUATIC WILDLIFE (COLD WATER)" |
#' ATTAINS.UseName == "AQUATIC WILDLIFE (WARM WATER)") |
#' (USE_CLASS_NAME_LOCATION_ETC == "DOMESTIC SOURCE, CLASS 1C" &
#' ATTAINS.UseName == "DOMESTIC SOURCE"))
#'
#' # Next, enter the crosswalk generated above as the paramRef function input
#' # for TADA_CrosswalkCSTATTAINSUses():
#' paramUsesRef_UT <- TADA_CreateParamUseRef(
#' org_id = "UTAHDWQ",
#' Data_Nutrients_UT,
#' usesRef = modified.useRef_UT,
#' paramRef = paramRef_UT2,
#' excel = FALSE
#' )
#'
#' # Now, run TADA_MLSummary()
#' MLSummaryRef_UT <- TADA_MLSummary(
#' Data_Nutrients_UT,
#' org_id = c("UTAHDWQ"),
#' AU_UsesRef = NULL, AUMLRef = NULL,
#' paramUseRef = paramUsesRef_UT,
#' excel = FALSE
#' )
#' # Create The criteria and methods table from the MLSummaryRef (see TADA_DefineCriteriaMethodology for alternative methods for generating criteria tables.
#' #CriteriaMethods_UT <- TADA_DefineCriteriaMethodology(Data_Nutrients_UT, org_id = "UTAHDWQ", MLSummaryRef = MLSummaryRef_UT)
Required
Update your branch from the latest
developand resolve any merge conflictsRun devtools::test(), devtools::check(), and devtools::document() locally; ensure tests pass and fix any errors, warnings, or notes. Add new dependencies to
DESCRIPTIONand document appropriatelyAdd/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 coveredConditional
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 viaMaintenanceScheduled.Ror trigger the Component File Update GitHub ActionIf new example data files were added, document them in
ExampleData.Rand include them inMaintenanceScheduled.Rfor regular refreshIf columns were added/updated, update
RequiredCols.RIf changes affect other package or the shiny app functions, update those impacted functions accordingly