lockedata / starters

R Package 📦 for initializing projects for various R activities :nut_and_bolt:
https://itsalocke.com/starters/
GNU General Public License v3.0
124 stars 16 forks source link

Make a starter shiny package template #129

Open stephlocke opened 5 years ago

stephlocke commented 5 years ago

Let's enable people to get a shiny app package going quickly.

maelle commented 5 years ago

For reference here is the template used by golem https://github.com/ThinkR-open/golem/tree/master/inst/shinyexample Using that and renaming/filling stuff would be quite different from current functions starters has.

stephlocke commented 5 years ago

It covers a lot of the basic stuff we expect e.g. DESCRIPTION, R/ via: https://github.com/ThinkR-open/golem/blob/master/R/create_shiny_template.R

It then expects users to run numerous config / best practice things from usethis which I like starters to do by default including a bunch of stuff we can directly do because of our whoami config etc https://github.com/ThinkR-open/golem/blob/master/README.md#fill-the-description

Also, having a different foundation isn't something the package tries to avoid - create_package_project leverages usethis not create_basic_package for instance.

maelle commented 5 years ago

What I meant is that we probably do not want a template with a DESCRIPTION because only running devtools::use_descdiption() uses the default DESCRIPTION fields from .Renviron. In theory could the Shiny pkg creation use createPackageProject(), use the ThinkR template parts for R/ and inst/ and add a few dependencies?

maelle commented 5 years ago

Big pros IMO of making it depend on createPackageProject() is less work duplication, a good example for further such packages (for addins, RMarkdown templates...) and we could have someone fairly new contribute 😇

But maybe there are elements of createPackageProject() we do not want here?