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

[Refactor]: Remove FIMSFrameAge #590

Closed
Tracked by #567
kellijohnson-NOAA opened this issue May 10, 2024 · 0 comments · Fixed by #594
Closed
Tracked by #567

[Refactor]: Remove FIMSFrameAge #590

kellijohnson-NOAA opened this issue May 10, 2024 · 0 comments · Fixed by #594
Labels
kind: refactor Restructure code to improve the implementation of FIMS P3 low priority task theme: code cleanup theme: R interface
Milestone

Comments

@kellijohnson-NOAA
Copy link
Contributor

Refactor request

Remove FIMSFrameAge because the complexity is not needed and it causes confusion. This will require moving some functionality from FIMSFrameAge to FIMSFrame and removing FIMSFrameAge from the vignette and all case studies that copied that part of the vignette into their quarto documents.

@kellijohnson-NOAA kellijohnson-NOAA added kind: refactor Restructure code to improve the implementation of FIMS P3 low priority task theme: R interface theme: code cleanup labels May 10, 2024
@kellijohnson-NOAA kellijohnson-NOAA added this to the 2 milestone May 10, 2024
kellijohnson-NOAA added a commit that referenced this issue May 10, 2024
kellijohnson-NOAA added a commit that referenced this issue May 10, 2024
kellijohnson-NOAA added a commit that referenced this issue May 10, 2024
@kellijohnson-NOAA kellijohnson-NOAA mentioned this issue May 13, 2024
1 task
kellijohnson-NOAA added a commit that referenced this issue May 14, 2024
kellijohnson-NOAA pushed a commit that referenced this issue May 14, 2024
by cleaning up the R code

Removes functions
* mkObj
* create_rcpp_interface_object
* use_module
* %>%
* FIMSFrameAge

Adds importFrom(TMB, MakeADFun) to package b/c TMB is no longer
explicitly used in the codebase. And, experimented with removing usethis
b/c it was also used in ./R/ but is still used in data-raw. It is now a
suggested package. Uses :: instead of importing functions, e.g.,
utils::head().

* Constricts line width to 80 characters
* Use full stops at the end of sentences
* Implement more spacing in between roxygen tags
* Move export tag to the end in most instances
* Use explicit brackets for if statements
* Remove duplicated code in gtest by calling run_gtest()
* Parameter and object names to snake_case
* Parameter, function, and object names, largely, w/o abbreviations

fix(run_gtest): Use paste() instead of paste0() to ensure proper spacing
which is not explicit in the instructions. With paste()
they can input as many additional arguments as they want and they are
all automatically separated, e.g.,
`run_gtest("--something", "--something-else")`

Close #588
Close #564
Close #590
Andrea-Havron-NOAA pushed a commit that referenced this issue May 25, 2024
by cleaning up the R code

Removes functions
* mkObj
* create_rcpp_interface_object
* use_module
* %>%
* FIMSFrameAge

Adds importFrom(TMB, MakeADFun) to package b/c TMB is no longer
explicitly used in the codebase. And, experimented with removing usethis
b/c it was also used in ./R/ but is still used in data-raw. It is now a
suggested package. Uses :: instead of importing functions, e.g.,
utils::head().

* Constricts line width to 80 characters
* Use full stops at the end of sentences
* Implement more spacing in between roxygen tags
* Move export tag to the end in most instances
* Use explicit brackets for if statements
* Remove duplicated code in gtest by calling run_gtest()
* Parameter and object names to snake_case
* Parameter, function, and object names, largely, w/o abbreviations

fix(run_gtest): Use paste() instead of paste0() to ensure proper spacing
which is not explicit in the instructions. With paste()
they can input as many additional arguments as they want and they are
all automatically separated, e.g.,
`run_gtest("--something", "--something-else")`

Close #588
Close #564
Close #590
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind: refactor Restructure code to improve the implementation of FIMS P3 low priority task theme: code cleanup theme: R interface
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants