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

Functional updates to R package - improved user options & record nhdplusTools retrieval metadata #27

Closed
wants to merge 141 commits into from

Conversation

glitt13
Copy link
Collaborator

@glitt13 glitt13 commented Oct 23, 2024

Modify the script fs_attrs_grab.R to argparse a user-config file and easily run in command line.
Modify proc_attr_wrap to allow user-specified hydrofabric arguments when calling hfsubsetR::get_subset() by creating hfab_config_opt
Provide user-option to not acquire hydrofabric data (hfab_retr=FALSE)
Add arguments in attribute config file corresponding to aforementioned features.
Create .csv download of nldi features generated by nhdplusTools

Additions

Create hfab_config_opt() to auto-generate arguments for hfsubsetR::get_subset() if not provided, and create associated unite test. Modified the script fs_attrs_grab.R to run hfab_config_opt.
Add arguments in attribute config file corresponding to configuring hfsubsetR::get_subset()
Create .csv download of nldi features generated by nhdplusTools, saving inside the user_data_std/dataset directory, with the filename following the standard format glue::glue('nldi_feat_{dataset_name}.csv'). This file will be useful for results/plots.

Removals

Changes

Modify the script fs_attrs_grab.R to argparse a user-config file and easily run in command line.
Modify proc_attr_wrap to allow user-specified hydrofabric arguments when calling hfsubsetR::get_subset(). Default hfab_retr=FALSE means skip downloading hydrofabric data.

Testing

  1. Create the test for "hfab_config_opt"

Screenshots

Notes

Todos

Checklist

  • PR has an informative and human-readable title
  • Changes are limited to a single goal (no scope creep)
  • Code can be automatically merged (no conflicts)
  • Code follows project standards (link if applicable)
  • Passes all existing automated tests
  • Any change in functionality is tested
  • New functions are documented (with a description, list of inputs, and expected output)
  • Placeholder code is flagged / future todos are captured in comments
  • Visually tested in supported browsers and devices (see checklist below 👇)
  • Project documentation has been updated (including the "Unreleased" section of the CHANGELOG)
  • Reviewers requested with the Reviewers tool ➡️

Testing checklist

Many unit tests for proc.attr.hydfab will continue to fail until the attribute data in the hydrofabric s3 bucket becomes publicly available, and once version 2.2 of the hydrofabric becomes publicly available.

Target Environment support

  • Windows
  • Linux
  • Browser

Accessibility

  • Keyboard friendly
  • Screen reader friendly

Other

  • Is useable without CSS
  • Is useable without JS
  • Flexible from small to large screens
  • No linting errors or warnings
  • JavaScript tests are passing

glitt13 and others added 30 commits August 22, 2024 09:29
describe the unique dependencies
…fix associated functions when behavior didn't follow expected behavior
…go_train_eval module; feat: move some hard-coded variables into the algorithm config file
…ture needs to be created to allow local_paths
…in quotes. Does not affect how R reads yaml file
…onfig_opt(), default assign hydrofabric retrieval as optional
@glitt13 glitt13 requested a review from bolotinl October 23, 2024 00:13
@glitt13
Copy link
Collaborator Author

glitt13 commented Oct 30, 2024

@lbolotin - ready for review! The latest change reworked how the attribute metadata containing the comid is saved and loaded in R, and read in via python.

@glitt13 glitt13 closed this Oct 31, 2024
@glitt13
Copy link
Collaborator Author

glitt13 commented Oct 31, 2024

Closing this PR because it is stuck on "Processing updates" and isn't showing the last couple commits.

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.

2 participants