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

Closes #237: deprecation #251

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Closes #237: deprecation #251

wants to merge 7 commits into from

Conversation

ukey1025
Copy link
Collaborator

@ukey1025 ukey1025 commented Oct 8, 2024

Thank you for your Pull Request! We have developed this task checklist from the Development Process Guide to help with the final steps of the process. Completing the below tasks helps to ensure our reviewers can maximize their time on your code as well as making sure the admiral family codebase remains robust and consistent.

Please check off each taskbox as an acknowledgment that you completed the task or check off that it is not relevant to your Pull Request. This checklist is part of the Github Action workflows and the Pull Request will not be merged into the main branch until you have checked off each task.

  • Place Closes #<insert_issue_number> into the beginning of your Pull Request Title (Use Edit button in top-right if you need to update).
  • Code is formatted according to the tidyverse style guide. Run styler::style_file() to style R and Rmd files.
  • Updated relevant unit tests or have written new unit tests, which should consider realistic data scenarios and edge cases, e.g. empty datasets, errors, boundary cases etc. - See Unit Test Guide
  • If you removed/replaced any function and/or function parameters, did you fully follow the deprecation guidance?
  • Update to all relevant roxygen headers and examples, including keywords and families. Refer to the [categorization of functions]
  • Run devtools::document() so all .Rd files in the man folder and the NAMESPACE file in the project root are updated appropriately.
  • Address any updates needed for vignettes and/or templates
  • Update NEWS.md under the header # admiralophtha (development version) if the changes pertain to a user-facing function (i.e. it has an @export tag) or documentation aimed at users (rather than developers)
  • Build admiralophtha site pkgdown::build_site() and check that all affected examples are displayed correctly and that all new functions occur on the "Reference" page.
  • Address or fix all lintr warnings and errors - lintr::lint_package().
  • Run R CMD check locally and address all errors and warnings - devtools::check().
  • Link the issue so that it closes after successful merging.
  • Address all merge conflicts and resolve appropriately.
  • Pat yourself on the back for a job well done! Much love to your accomplishment!

Copy link
Collaborator

@manciniedoardo manciniedoardo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @ukey1025.

  • Please update the roxygen header of derive_var_afeye,R to remove references to dataset_occ and lat_vals.
  • Please remove the deprecation tests for these arguments as well (see here) as they will fail otherwise.

NEWS.md Outdated

## Updates to Functions

- The following function arguments of `derive_var_afeye()` are removed (#237):
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- The following function arguments of `derive_var_afeye()` are removed (#237):
- The following function arguments of `derive_var_afeye()` are removed following the end of their deprecation cycle.(#237):

@manciniedoardo manciniedoardo changed the title Git commit for issue #237 Closes #237 Oct 21, 2024
@manciniedoardo manciniedoardo changed the title Closes #237 Closes #237: deprecation Oct 21, 2024
@manciniedoardo
Copy link
Collaborator

@ukey1025:

  • please fix the code style check by running: styler::style_file("R/derive_var_afeye.R")
  • please fix the man pages check by running: roxygen2::roxygenize('.', roclets = c('rd', 'collate', 'namespace'))

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.

Next stage of deprecation cycle for derive_var_afeye() arguments
2 participants