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.

Sign up for GitHub

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

Jump to bottom

Closes #2458 Updated cheatsheet in line with 1.1 and 1.2 changes #2600

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

Closes #2458 Updated cheatsheet in line with 1.1 and 1.2 changes #2600

wants to merge 8 commits into from

Conversation

manciniedoardo
Copy link
Collaborator

@manciniedoardo manciniedoardo commented Dec 10, 2024 •
edited
Loading

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 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?
  • Review the Cheat Sheet. Make any required updates to it by editing the file inst/cheatsheet/admiral_cheatsheet.pptx and re-upload a PDF and a PNG version of it to the same folder. (The PNG version can be created by taking a screenshot of the PDF version.)
  • Update to all relevant roxygen headers and examples, including keywords and families. Refer to the categorization of functions to tag appropriate keyword/family.
  • 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 # admiral (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). A Developer Notes section is available in NEWS.md for tracking developer-facing issues.
  • Build admiral 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 in the Development Section on the right hand side.
  • Address all merge conflicts and resolve appropriately
  • Pat yourself on the back for a job well done! Much love to your accomplishment!

@manciniedoardo manciniedoardo linked an issue Dec 10, 2024 that may be closed by this pull request
Documentation: Bring cheatsheet into alignment with 1.1.0 and 1.2.0 changes #2458
Open
9 tasks
@github-actions GitHub Actions
Copy link

github-actions bot commented Dec 10, 2024 •
edited
Loading

Code Coverage

Package Line Rate Health
admiral 98% ✔
Summary 98% (5186 / 5299) ✔

@manciniedoardo
Copy link
Collaborator Author

@bms63 @bundfussr to aid your review, you can see the updates I made in the #2458 checklist.

@manciniedoardo
Copy link
Collaborator Author

Sorry, my bad, I also just now noticed there were some partial updates already here...!

bundfussr
bundfussr requested changes Dec 11, 2024
View reviewed changes
Copy link
Collaborator

@bundfussr bundfussr left a comment

Choose a reason for hiding this comment

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

  • I would remove impute_dtc_dt() and impute_dtc_dtm() and add compute_scale() in the "Computation Functions for Vectors" section because it is very unlikely that users will call the impute_*() functions.
  • Should we add derive_vars_cat() to "Special Variable-Adding Functions"?
  • For derive_var_anrind() ... should be added to the arguments because there are more than stated.
  • Should we replace derive_var_atoxgr() with derive_var_atoxgr_dir() as the latter is function which does the work?
  • I would change the description of derive_vars_period() to "Add ADSL subperiod, period, or phase variables."
  • filter_relative() is invisible in the PDF version:
    image
  • The link to derive_extreme_records() is broken because the ".html" was added twice.

@manciniedoardo
Copy link
Collaborator Author

manciniedoardo commented Dec 11, 2024 •
edited
Loading

Thanks @bundfussr for the review. I've addressed all of the above except:

Should we add derive_vars_cat() to "Special Variable-Adding Functions"?

because there is simply not enough space, so would rather keep under generic.

@bms63
Copy link
Collaborator

bms63 commented Dec 11, 2024

Should we close this and re-submit? rstudio/cheatsheets#555

@manciniedoardo
Copy link
Collaborator Author

manciniedoardo commented Dec 11, 2024 •
edited
Loading

I think better would be: merge this one, close #2479, and update the this so with the new cheatsheet. I think we should not wait for RStudio.

bundfussr
bundfussr requested changes Dec 11, 2024
View reviewed changes
Copy link
Collaborator

@bundfussr bundfussr left a comment

Choose a reason for hiding this comment

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

  • "ADSL" was not added to the description of derive_vars_period().
  • The arguments of derive_var_atoxgr_dir() are not correct.
  • For compute_scale() only the underscore is a link but not the complete function name.

@bundfussr
Copy link
Collaborator

I have updated rstudio/cheatsheets#555 to the latest version of the cheatsheet.

@bundfussr
Copy link
Collaborator

@manciniedoardo , I did a small update for derive_vars_crit_flag() see #2616

@manciniedoardo
Copy link
Collaborator Author

Thanks @bundfussr

@github-actions GitHub Actions
Copy link

github-actions bot commented Jan 8, 2025

This Pull Request is stale because it has not been worked on in 15 days.

@github-actions github-actions bot added the stale label Jan 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bundfussr bundfussr bundfussr approved these changes

@bms63 bms63 Awaiting requested review from bms63

Assignees
No one assigned
Labels
stale wait until right after release
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Documentation: Bring cheatsheet into alignment with 1.1.0 and 1.2.0 changes
3 participants
@manciniedoardo @bms63 @bundfussr