Open jdhoffa opened 9 months ago
{usethis} typically does too much magic for my taste, so I'm not really sure what's possible... but sounds interesting.
For flavor, some of the things we could wrap:
pacta.*
or workflow.*
template repos (seems a bit overkill tbh)Could potentially wrap a lot of the tidyverse helpers, replace tidy
with rmi
, e.g.:
use_rmi_logo
: To add the RMI logo to a repo README
use_rmi_github_actions
: To use different GH actions from our Actions repo. Could define "mandatory" actions and have a CLI for "optional" actions or something like thatuse_*_badge
: to add badgesNone of these things are ground-breaking, but they would allow a utility to ensure we can stay somewhat self-consistent if we want to... Especially now that we have so many individual maintainers, it would be nice to have some standards that help us to not diverge completely.
The benefit I see to this, over just having the template repo, is that the maintainer at the end of the day would decide if/ how/ when they want to use any of these, so @cjyetman if you would prefer not to use "magic side effect" functions, you could still just do everything manually.
Then, the main question would be, who if anyone would find this useful, and is it enough appetite to warrant maintaining it? The "users" of this that I could imagine are @RMI-PACTA/developers, so can you guys just comment a 👍 or 👎 if this is something you would be interested in/ find useful, and we can go from there?
Soft 👍 (honestly I also just use usethis
and am happy to keep doing that and maintaining things manually, its not such a big burden for me)
An example usethis
wrapper can be seen here: https://github.com/RMI-PACTA/r2dii.usethis
I would be happy to use it if it exists but at the same time, I am not sure if the amount of time we would use it is worth the effort. And if having good practices around package maintenance is not enough here without a helper package. Maybe before we start developing it it would be useful to list all the potential candidates for usethis
-like functions specific to our work? Or if not all then some.
usethis provides utility functions that allow easy (and consistent) development of R packages. We may consider writing a wrapper package around this, to facilitate the building and deployment of RMI style R packages.
This could include, for example:
README
spkgdown
websitesTwo benefits of this approach:
pacta.r.packge
FYI. @cjyetman and @AlexAxthelm curious to hear your thoughts here