Closes #2593 feat: Add my_first_fcn to welcome new users #2593
Task list completed / task-list-completed
Started
2024-12-19 22:33:54
ago
0 / 15 tasks completed
15 tasks still to be completed
Details
Required Tasks
| Task | Status |
|---|---|
| Create new function my_first_fcn() | Incomplete |
| Add corresponding test | Incomplete |
| Resolves #1839 | Incomplete |
| Place Closes #<insert_issue_number> into the beginning of your Pull Request Title (Use Edit button in top-right if you need to update) | Incomplete |
Code is formatted according to the tidyverse style guide. Run styler::style_file() to style R and Rmd files |
Incomplete |
| 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 | Incomplete |
| If you removed/replaced any function and/or function parameters, did you fully follow the deprecation guidance? | Incomplete |
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.) |
Incomplete |
| Update to all relevant roxygen headers and examples, including keywords and families. Refer to the categorization of functions to tag appropriate keyword/family. | Incomplete |
Run devtools::document() so all .Rd files in the man folder and the NAMESPACE file in the project root are updated appropriately |
Incomplete |
| Address any updates needed for vignettes and/or templates | Incomplete |
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. |
Incomplete |
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. |
Incomplete |
Address or fix all lintr warnings and errors - lintr::lint_package() |
Incomplete |
Run R CMD check locally and address all errors and warnings - devtools::check() |
Incomplete |
| Link the issue in the Development Section on the right hand side. | Incomplete |
| Address all merge conflicts and resolve appropriately | Incomplete |
| Pat yourself on the back for a job well done! Much love to your accomplishment! | Incomplete |
| Fixed bug for admiral_fcn() where users doing this caused this (#1814) | Incomplete |
| Updated the message in R/my_first_fcn.R from "Welcome to admiral!" to "Welcome to the admiral family!". | Incomplete |
| The associated .Rd documentation in man/my_first_fcn.Rd has been updated accordingly. | Incomplete |
Loading