dev/02_dev.R

In vdes2020/eneRgyVD: Municipal statistics for climate-related policies, Canton de Vaud (Switzerland)

# Building a Prod-Ready, Robust Shiny Application.
#
# README: each step of the dev files is optional, and you don't have to
# fill every dev scripts before getting started.
# 01_start.R should be filled at start.
# 02_dev.R should be used to keep track of your development during the project.
# 03_deploy.R should be used once you need to deploy your app.
#
#
###################################
#### CURRENT FILE: DEV SCRIPT #####
###################################

# Engineering

## Dependencies ----
## Amend DESCRIPTION with dependencies read from package code parsing

attachment::att_amend_desc()

usethis::use_pipe()
usethis::use_package("shiny")
usethis::use_package("dplyr")
usethis::use_package("purrr")
usethis::use_package("glue")
usethis::use_package("readr")
usethis::use_package("openxlsx") # allows NA reformatting (for confidential data)
usethis::use_package("tidyr")
usethis::use_package("forcats")
usethis::use_package("ggiraph")
usethis::use_package("ggplot2")
usethis::use_package("ggalluvial")
usethis::use_package("DT")
usethis::use_package("scales")
usethis::use_package("rjson")
usethis::use_package("shinyWidgets")

usethis::use_package("shinycssloaders")
usethis::use_package("leaflet")
usethis::use_package("leaflet.extras")
usethis::use_package("sf")
usethis::use_package("htmltools")
usethis::use_package("bookdown") # for rmd rendering

usethis::use_package("promises") # asnyc report download
usethis::use_package("future")   # asnyc report download ## RUN THIS ##

usethis::use_package("shinylogs") # record session logs for user tracking

# UPDATE bs5

usethis::use_package("bslib")
usethis::use_package("phosphoricons")


## Add modules ----
## Create a module infrastructure in R/
golem::add_module(name = "inputs", with_test = TRUE)
golem::add_module(name = "prod_charts", with_test = TRUE)
golem::add_module(name = "cons_charts", with_test = TRUE)
golem::add_module(name = "download_data", with_test = TRUE)
golem::add_module(name = "vd_collapse_box", with_test = TRUE)
golem::add_module(name = "communes_boxes", with_test = TRUE)
golem::add_module(name = "download_rmd", with_test = TRUE)
golem::add_module(name = "about_the_app", with_test = TRUE)
golem::add_module(name = "elec_charts", with_test = TRUE)
golem::add_module(name = "regener_cons_charts", with_test = TRUE)
golem::add_module(name = "regener_needs_charts", with_test = TRUE)
golem::add_module(name = "regener_misc_charts", with_test = TRUE)
golem::add_module(name = "subsidies_building_charts", with_test = TRUE)
golem::add_module(name = "subsidies_measure_charts", with_test = TRUE)
golem::add_module(name = "ng_charts", with_test = FALSE)
golem::add_module(name = "upload_communes", with_test = FALSE)
golem::add_module(name = "news", with_test = FALSE)
golem::add_module(name = "generic_charts", with_test = TRUE)
golem::add_module(name = "table_content", with_test = FALSE)
golem::add_module(name = "download_all_data", with_test = FALSE)
golem::add_module(name = "unit_converter", with_test = FALSE)

## Add helper functions ----
## Creates fct_* and utils_*
golem::add_fct("helpers", with_test = TRUE)
golem::add_utils("helpers", with_test = TRUE)
golem::add_utils("text", with_test = TRUE)

## External resources
## Creates .js and .css files at inst/app/www
golem::add_js_file("script")
golem::add_js_handler("handlers")
golem::add_sass_file("custom")

## Add internal datasets ----
## If you have data in your package
usethis::use_data_raw(name = "electricity_consumption", open = FALSE)

## Tests ----
## Add one line by test you want to create
usethis::use_test("app")

# Documentation

## Vignette ----
usethis::use_vignette("eneRgyVD")
devtools::build_vignettes()

## Code Coverage----
## Set the code coverage service ("codecov" or "coveralls")
# usethis::use_coverage()
#
# # Create a summary readme for the testthat subdirectory
# covrpage::covrpage()

## CI ----
## Use this part of the script if you need to set up a CI
## service for your application

## (You'll need GitHub there)
usethis::use_github()

# GitHub Actions
usethis::use_github_action()
# Chose one of the three
# See https://usethis.r-lib.org/reference/use_github_action.html
usethis::use_github_action_check_release()
usethis::use_github_action_check_standard()
usethis::use_github_action_check_full()
# Add action for PR
usethis::use_github_action_pr_commands()

# Travis CI
usethis::use_travis()
usethis::use_travis_badge()

# Licence
usethis::use_gpl_license(version = 3, include_future = TRUE)

# AppVeyor
usethis::use_appveyor()
usethis::use_appveyor_badge()

# Circle CI
usethis::use_circleci()
usethis::use_circleci_badge()

# Jenkins
usethis::use_jenkins()

# GitLab CI
usethis::use_gitlab_ci()

# You're now set! ----
# go to dev/03_deploy.R
rstudioapi::navigateToFile("dev/03_deploy.R")