apptemplate provides a template for a new R package that builds a Shiny app and modules.
It includes useful internal functions, example Shiny modules and functions to build and deploy a Shiny app.
Installation
To install the latest release from CRAN
install.packages("apptemplate")
To install the developmental version from GitHub
# install.packages("remotes") remotes::install_github("poissonconsulting/apptemplate")
Demonstration
In order to create a new package the user should
1) Go to the apptemplate GitHub repository and choose ‘Use this template’. 2) Clone the new repository and replace ‘apptemplate’ with the name of the new package in DESCRIPTION, NEWS.md, tests/testthat.R, dev/deploy.R, inst/app/server.R, inst/app/ui.R, R/app_server.R, R/app_ui.R, R/mod_module.R, R/onload.R, R/run_app.R and this README.Rmd file. 3) devtools::check() the package and fix any Errors, Warnings or Notes. 4) Knit this README.Rmd file and pkgdown::build_site(). 5) Add the project to Travis and in the Settings add a Cron Job to run the master branch daily if there hasn’t been a build in the last 24h. 6) Add the project to Appveyor. 7) Rename the apptemplate.Rproj file. 8) Push the changes to the new repository. 9) Go to the repository GitHub settings and set the GitHub Pages Source to be the master branch /docs folder. 10) Edit the GitHub repository description and set the website to be https://poissonconsulting.github.io/apptemplate/.
To add modules, use golem::add_module().
Code of Conduct
Please note that the apptemplate project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.
