qol (version 1.1.1)

build_master: Build a Master Script From Folder

Description

build_master() reads a given folder structure, which contains scripts, and builds a master script as a markdown file.

Usage

build_master(
  dir,
  master_name = "Master",
  with_structure = TRUE,
  with_run_all = TRUE,
  with_run_folder = TRUE
)

Value

Returns the script as character vector and saves it as markdown file.

Arguments

dir

The folder structure which contains the scripts to build upon.

master_name

The file name which should be written.

with_structure

Whether the folder structure as tree should be written to the master script.

with_run_all

Whether a section, which let's the user run all scripts, should be written to the master script.

with_run_folder

Whether a section, which let's the user run all scripts from a specific folder, should be written to the master script.

Details

The function works with folder structures that look like this:

root/

 subfolder1/
     script1.R
     script2.R
     ....R
 subfolder2/
     script3.R
     script4.R
     ....R
 .../
     ....R

Examples

build_master(dir = "C:/My Projects/Code", master_name = "Master Script")