update_project: Setup a new period for a project

Description Usage Arguments See Also

View source: R/update.R

Description

This will setup files based on a reference time period, rather than creating new files based on the default template. By default, the new analysis folder will include all ref_period R files (.R, .Rmd, etc.) and their containing folders, as well as .txt/.tex files.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
update_project(
  state,
  period,
  ref_period,
  ref_path = file.path("E:/SA/Projects/Data-Dashboards", state, ref_period),
  analysis_path = file.path("E:/SA/Projects/Data-Dashboards", state, period),
  sensitive_path = file.path("E:/SA/Data-Sensitive/Data-Dashboards", state,
    paste0("raw-", period)),
  production_path = file.path("E:/SA/Data-Production/Data-Dashboards", state),
  files_to_keep = c("\\.r", "documentation\\.tex", "\\.txt"),
  top_level_files = c(".Rprofile", "README.md", "renv.lock", "renv/activate.R",
    "renv/settings.dcf")
)

Arguments

state

character: Two letter state designation

period

character: Time period for the first project (e.g., "2019-q4", "2020-q4", etc.)

ref_period

folder name of reference time period (e.g., 2019-q4)

ref_path

full file path to reference period analysis folder

analysis_path

character: File path for the analysis

sensitive_path

character: File path for the sensitive data. If NULL, no folders will be created.

production_path

character: File path for the production data. If NULL, no folders will be created.

files_to_keep

patterns for matching on files in the "code" folder using grep (not case sensitive). Files with matching patterns will be copied from ref_period.

top_level_files

top-level analysis files that should be copied over

See Also

Other functions to update projects: setup_data_dive()


southwick-associates/lictemplate documentation built on Jan. 10, 2022, 6:44 p.m.