closes #71 closes #74 closes #78 updates from admiralpeds experience

[rossfarrugia]

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 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<ext> (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 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!

[rossfarrugia]

@bms63 @manciniedoardo here's a bunch of updates i think would have helped make admiralpeds easier so hopefully passing on the favour for admiralmetabolic. shout if you disagree with any though.

one big update was the news file here where my justification is that people dont need to track the changes of this template repo as they always should only care about the latest version when they come to use it. we should set it up so that each pkg ext team has the minimum amount of updates and clarity on how they should update, rather than treating this template as a package where we have to maintain a changelog of changes.

[manciniedoardo]

LGTM, one minor comment about the slack link, agree on the NEWS.md front.

[bms63]

Oh I sort of like the news … history of what we have done! Was this confusing for folks? I like the message it sends that we catalog changes even for our template repo :) but if y’all think it’s got to go then all good

[rossfarrugia]

I'd say people can look to admiral or other pkg ext news files for examples. the confusing thing in having it was that every new pkg ext team starts logging every change from the start but in reality you only need this populated after you make first release, as everything until then is just release 1 features and not changes that users need to be aware of.

[bms63]

okay that makes sense. I was referring to the actual news for working on admiraltemplate, but it sounds like that is going to be jettison which is fine.

[bms63]

Way cool Ross! Just some thoughts on a few things. I’m not super passionate about any of them.

Other ideas that maybe others can work on:

• snapshot tests example with two examples one works and one errors (this really makes writing tests so much less painful)
• Remotes in DESCRIPTION

these overkill? I can make into issues if not

[bms63]

Can we remove renv reference in readme

[rossfarrugia]

@bms63 @manciniedoardo thanks for the review! replies added above, and renv already removed from README. if you're ok with my replies feel free to approve/merge or make changes as you wish if otherwise. for the other ideas then go ahead and make issues/PRs as needed. i just wanted to get these all in ahead of whenever admiralmetabolic repo gets created.