RMI-PACTA / pacta.r.package

This repository can be used as a template for all PACTA R packages. It includes typical R package scaffolding, and GH actions by default.
Other
1 stars 0 forks source link

Consider deprecating this in favour of a `pacta.usethis` package #11

Open jdhoffa opened 9 months ago

jdhoffa commented 9 months ago

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:

Two benefits of this approach:

FYI. @cjyetman and @AlexAxthelm curious to hear your thoughts here

cjyetman commented 9 months ago

{usethis} typically does too much magic for my taste, so I'm not really sure what's possible... but sounds interesting.

jdhoffa commented 9 months ago

For flavor, some of the things we could wrap:

Could potentially wrap a lot of the tidyverse helpers, replace tidy with rmi, e.g.:

None 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?

jdhoffa commented 9 months ago

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)

jdhoffa commented 9 months ago

An example usethis wrapper can be seen here: https://github.com/RMI-PACTA/r2dii.usethis

MonikaFu commented 9 months ago

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.