DashboardInitialiseOpinionated: DashboardInitialiseOpinionated

In raubreywhite/fhi: FHI Convenience Functions

Description

This function relies upon you using the dashboard folder setup: vignette("dashboardbasics", package = "fhi"). This function specifies all of the location of necessary files for the dashboard setup.

Usage

DashboardInitialiseOpinionated(
  NAME,
  PKG = NAME,
  STUB = "/",
  PACKAGE_DIR = ".",
  FORCE_DEV_PACKAGE_LOAD = FALSE,
  DEV_IF_RSTUDIO = TRUE,
  SILENT = FALSE,
  PRODUCTION_NAME = PROJ$PRODUCTION_NAME,
  EMAILS_XLSX_LOCATION_DEV = file.path("/etc", "gmailr", "emails_test.xlsx"),
  EMAILS_XLSX_LOCATION_PROD = file.path("/etc", "gmailr", "emails.xlsx"),
  EMAILS_OAUTH_LOCATION = file.path("/etc", "gmailr", ".httr-oauth")
)

Arguments

NAME	The name of the automated analysis folders
PKG	The name of the R package (generally the same as 'NAME')
STUB	The directory containing the 'data_raw', 'data_clean', 'data_app', and 'results' folders
PACKAGE_DIR	The directory containing the package source code
FORCE_DEV_PACKAGE_LOAD	a
DEV_IF_RSTUDIO	If function is called from RStudio, flag 'PROJ$IS_DEV' as 'TRUE'
SILENT	Load all packages silently?
PRODUCTION_NAME	The name of the production computer
EMAILS_XLSX_LOCATION_DEV	Location of the excel sheet that holds email lists (used on development computers)
EMAILS_XLSX_LOCATION_PROD	Location of the excel sheet that holds email lists (used on production computer)
EMAILS_OAUTH_LOCATION	Location of the '.httr-oauth' file for use in 'gmailr'

raubreywhite/fhi documentation built on Jan. 5, 2020, 2:54 p.m.