dev/02_dev.R

In CDU-data-science-team/experiencesdashboard: Patient Experiences Dashboard

# 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

stop()

## Dependencies ----
## Add one line by package you want to add as dependency - CRAN
usethis::use_package("thinkr")
usethis::use_package("dplyr")
usethis::use_package("tibble")
usethis::use_package("ggplot2")
usethis::use_package("purrr")
usethis::use_package("tidyr")
usethis::use_package("readr")
usethis::use_package("stringr")
usethis::use_package("forcats")
usethis::use_package("reactable")
usethis::use_package("UpSetR")
usethis::use_package("tibbletime")
usethis::use_package("shinydashboard")
usethis::use_package("dashboardthemes")
usethis::use_package("shinyWidgets")
usethis::use_package("waiter")
usethis::use_package("shinyjqui")
usethis::use_package("timevis")
usethis::use_package("rmarkdown")
usethis::use_package("pander")
usethis::use_package("pool")
usethis::use_package("odbc")
usethis::use_package("DBI")
usethis::use_package("dbplyr")
usethis::use_package("datamods")
usethis::use_package("here")
usethis::use_package("shinycssloaders")
usethis::use_package("xml2")
usethis::use_package("plotly")
usethis::use_package("fresh")
usethis::use_package("writexl")
usethis::use_package("memoise")
usethis::use_package("data.validator")
usethis::use_package("pool")
usethis::use_package("pins")

## Add one line by package you want to add as dependency - Non-CRAN e.g. GitHub
# usethis::use_dev_package("")

## Amend DESCRIPTION with dependencies read from package code parsing
attachment::att_amend_desc()

## Add modules ----
## Create a module infrastructure in R/
golem::add_module(name = "patient_experience") # Name of the module
golem::add_module(name = "search_text") # Name of the module
golem::add_module(name = "demographics") # Name of the module
golem::add_module(name = "data_management", fct = "helper") # Name of the module
golem::add_module(name = "summary_record") # Name of the module
golem::add_module(name = "demographics_selection") # Name of the module
golem::add_module(name = "documentation_page") # Name of the module
golem::add_module(name = "trend", utils = "helper") # Name of the module
golem::add_module(name = "header_message") # Name of the module
golem::add_module(name = "trend_overlap") # Name of the module
golem::add_module(name = "overlap_1") # Name of the module
golem::add_module(name = "comment_download", utils = "helper") # Name of the module
golem::add_module(name = "complex_comments") # Name of the module

## Add helper functions ----
## Creates ftc_* and utils_*
golem::add_fct("helpers")
golem::add_utils("helpers")
golem::add_utils("overlap_plot_helpers")
golem::add_fct("api_pred", with_test = TRUE)
golem::add_fct("get_complex_comments", with_test = TRUE)
golem::add_fct("nhs_shiny_theme")
golem::add_fct("app_server-helpers")

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

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

## Tests ----
# Adding the correct code coverage
# infrastructure in your application
usethis::use_coverage()

# Compute the code coverage of your application
covr::package_coverage() # this work too devtools:::test_coverage()
# identify files with zero code coverage
covr::zero_coverage(covr::package_coverage())

## Add one line by test you want to create
usethis::use_test("fft")
usethis::use_test("show_text")
usethis::use_test("search_text")
usethis::use_test("calculate_table")
usethis::use_test("tidy_data")
usethis::use_test("report_functions")
usethis::use_test("tidy_upload")
usethis::use_test("database-data")
usethis::use_test("fct_api_pred")
usethis::use_test("app_config")
usethis::use_test("filter_text")
usethis::use_test("spc_functions")
usethis::use_test("server-modules")
usethis::use_test("demographic_graphs")
usethis::use_test("fct_nhs_shiny_theme")
usethis::use_test("fct_app_server-helpers")
usethis::use_test("general_helpers")
usethis::use_test("mod_data_management_fct_helper")
usethis::use_test("app_server")
usethis::use_test("app_ui")
usethis::use_test("table_schemas")

# Documentation

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

## Code coverage ----
## (You'll need GitHub there)
usethis::use_github()
usethis::use_travis()
usethis::use_appveyor()

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