Closes #2458 Updated cheatsheet in line with 1.1 and 1.2 changes #2600
+3
−1
Task list completed / task-list-completed
succeeded
Jan 8, 2025 in 0s
15 / 15 tasks completed
All tasks have been completed
Details
Required Tasks
| Task | Status |
|---|---|
| Place Closes #<insert_issue_number> into the beginning of your Pull Request Title (Use Edit button in top-right if you need to update) | Completed |
Code is formatted according to the tidyverse style guide. Run styler::style_file() to style R and Rmd files |
Completed |
| 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 | Completed |
| If you removed/replaced any function and/or function parameters, did you fully follow the deprecation guidance? | Completed |
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.) |
Completed |
| Update to all relevant roxygen headers and examples, including keywords and families. Refer to the categorization of functions to tag appropriate keyword/family. | Completed |
Run devtools::document() so all .Rd files in the man folder and the NAMESPACE file in the project root are updated appropriately |
Completed |
| Address any updates needed for vignettes and/or templates | Completed |
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. |
Completed |
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. |
Completed |
Address or fix all lintr warnings and errors - lintr::lint_package() |
Completed |
Run R CMD check locally and address all errors and warnings - devtools::check() |
Completed |
| Link the issue in the Development Section on the right hand side. | Completed |
| Address all merge conflicts and resolve appropriately | Completed |
| Pat yourself on the back for a job well done! Much love to your accomplishment! | Completed |
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. |
Incomplete |
Should we add derive_vars_cat() to "Special Variable-Adding Functions"? |
Incomplete |
For derive_var_anrind() ... should be added to the arguments because there are more than stated. |
Incomplete |
Should we replace derive_var_atoxgr() with derive_var_atoxgr_dir() as the latter is function which does the work? |
Incomplete |
I would change the description of derive_vars_period() to "Add ADSL subperiod, period, or phase variables." |
Incomplete |
filter_relative() is invisible in the PDF version: |
|
 |
Incomplete |
The link to derive_extreme_records() is broken because the ".html" was added twice. |
Incomplete |
"ADSL" was not added to the description of derive_vars_period(). |
Incomplete |
The arguments of derive_var_atoxgr_dir() are not correct. |
Incomplete |
For compute_scale() only the underscore is a link but not the complete function name. |
Incomplete |
Loading