dev/01_start.R

# 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: ON START SCRIPT #####
########################################

## Fill the DESCRIPTION ----
## Add meta data about your application
## 
## /!\ Note: if you want to change the name of your app during development, 
## either re-run this function, call golem::set_golem_name(), or don't forget
## to change the name in the app_sys() function in app_config.R /!\
## 
golem::fill_desc(
  pkg_name = "phaRmacyForecasting", # The Name of the package containing the App 
  pkg_title = "Putting the R in pharmacy- a Shiny application to make forecasts 
  of medication use in pharmacies in Nottinghamshire Healthcare NHS Trust", # The Title of the package containing the App 
  pkg_description = "This is a Shiny application which allows users to make predictions 
  on the volumes of drugs issued from Nottinghamshire Healthcare pharmacies. A variety 
  of forecasting models are used, and options are provided to tweak the forecast to 
  improve model fit", # The Description of the package containing the App 
  author_first_name = "Chris", # Your First Name
  author_last_name = "Beeley", # Your Last Name
  author_email = "chris.beeley@gmail.com", # Your Email
  repo_url = "https://github.com/CDU-data-science-team/phaRmacyForecasting" # The URL of the GitHub Repo (optional) 
)     

## Set {golem} options ----
golem::set_golem_options()

## Create Common Files ----
## See ?usethis for more information
usethis::use_mit_license( copyright_holder = "Nottinghamshire Healthcare" )  # You can set another license here
usethis::use_readme_rmd( open = FALSE )
usethis::use_code_of_conduct()
usethis::use_lifecycle_badge( "Experimental" )
usethis::use_news_md( open = FALSE )

## Use git ----
usethis::use_git()

## Init Testing Infrastructure ----
## Create a template for tests
golem::use_recommended_tests()

## Use Recommended Packages ----
golem::use_recommended_deps()
usethis::use_pipe()

## Favicon ----
# If you want to change the favicon (default is golem's one)
golem::use_favicon() # path = "path/to/ico". Can be an online file. 
golem::remove_favicon()

## Add helper functions ----
golem::use_utils_ui()
golem::use_utils_server()

# You're now set! ----

# go to dev/02_dev.R
rstudioapi::navigateToFile( "dev/02_dev.R" )
CDU-data-science-team/phaRmacyForecasting documentation built on Jan. 2, 2023, 5:56 p.m.