README.md

In southwick-associates/sadashtemplate: Create template files for license data processing

lictemplate

An R package that provides template workflows for license data preparation and dashboard production. These templates make use of several other SA-built R packages: salic, salicprep, workflow, sadash.

Installation

From the R console:

install.packages("remotes")
remotes::install_github("southwick-associates/lictemplate")

Usage

Lictemplate provides functions to automate license data workflows:

• Initialize new projects:
  • new_project() for a basic processing workflow (e.g., national/regional dashboards)
  • new_project_summary() for states that provide summarized data for national/regional dashboards
  • new_project_individual() for the more involved individual state dashboards
• Update existing projects:
  • update_project() to copy the workflow from an earlier time period with updated parameters
  • setup_data_dive() to add code neeeded for a data dive project
  • data_archive() and data_backup() for managing license data

Example New Project

To begin a new project, first create data directories and template files for analysis. For example, creating a South Dakota dashboard project on the server:

lictemplate::new_project("SD", "2019-q4")
## A new license data project has been initialized:
##  E:/SA/Projects/Data-Dashboards/SD/2019-q4

Next, open the Rstudio project just created and build the project package library with package renv:

renv::restore()

See package salicprep for data processing guidelines.

southwick-associates/sadashtemplate documentation built on Jan. 8, 2022, 2:31 p.m.