configure_flash_freeze: Return a function "flash_freeze" that saves on...

In ekernf01/freezr: Easily Archive Quickly Changing Custom R Scripts For Reproducible Analysis

Description

Return a function "flash_freeze" that saves on project-specific boilerplate compared to "freeze".

Usage

configure_flash_freeze(
  project_directory = getwd(),
  setup_scripts = NULL,
  repos_to_track = project_directory
)

Arguments

project_directory	Where's your freezr project? Should contain subdirectories "results" and "scripts." Try "freezr::create_empty_project".
setup_scripts	Scripts to be run first every time you flash_freeze an analysis. Helps avoid copy-pasting code. For example, a setup script might load packages, utility functions, or reusable functions that you haven't yet packaged up.
repos_to_track	Helps track outside repos. See corresponding arg of 'freeze'.

Details

When run without args, this "flash_freeze" runs the setup scripts and saves to the "interactive" folder. Your namespace retains objects created by the setup scripts, so you can experience what your analysis scripts are experiencing. Otherwise, "flash_freeze" takes these args:

• "analyses_to_run" should be a character vector containing paths to R or .Rmd files in your "scripts" folder

• "results_subdir" should be a character vector to be added onto the "results" folder before It's optional, and if NULL (recommended), it names the results subfolder after the subfolder of the last analysis script. This way, the organizational structure is mirrored between the analysis scripts and the results.

• ... extra args passed to "freeze"

ekernf01/freezr documentation built on Feb. 8, 2022, 5:22 a.m.