rprojtree-primer"

In rprojtree: Create Folders and Files Structure for Data Science Projects

knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>"
)

library(rprojtree)

Quick start

This is a basic example which shows you how to create the structure of directories and files for your project:

library(rprojtree)

You can find out which templates are available in the package using:

available_templates()

Currently there are r length(available_templates()) templates (r paste(available_templates(), collapse = ", ")). These templates have .json format. You can view them using:

print_template("basic_template")

The "basic_template" template creates this basic structure:

<root_path>/data/
<root_path>/data/clean/
<root_path>/data/raw/
<root_path>/docs/
<root_path>/outputs/
<root_path>/outputs/files/
<root_path>/outputs/reports/
<root_path>/R
<root_path>/R/global.R
<root_path>/R/src/
<root_path>/R/scripts/

It is possible to indicate the text with which a file should be created. In the case of "basic template" the file <root_path>/R/global.Rglobal.R will contain:

DIR_DATA <- here::here('data')

DIR_RAW_DATA <- file.path(DIR_DATA, 'raw')
DIR_CLEAN_DATA <- file.path(DIR_DATA, 'clean')

DIR_OUTPUTS <- here::here('outputs')

DIR_OUTPUTS_REPORTS <- file.path(DIR_OUTPUTS, 'reports')
DIR_OUTPUTS_FILES <- file.path(DIR_OUTPUTS, 'files')

To finally create the project structure you can choose any of the built in templates:

root_path = "..." # Indicate the root directory of the structure

# Use a builtin template
make_prj_tree(json_str = "basic_template", path = root_path)

Or provide your own in a .json file:

# Use your own .json file
my_template <- ".../sample_template.json" 
make_prj_tree(file = my_template, path = root_path)

rprojtree documentation built on March 18, 2022, 7:45 p.m.