R/add_file_paths.R

In joepowers16/breadcrumbs: Breadcrumbs Helps You Maintain A Tidy Workflow During EDA

#' adds a standardized file_paths.R project root directory
#'
#' This function adds a standardized file_paths.R project root directory
#' @keywords file_paths.R
#' @export
#' @examples
#' add_file_paths()

add_file_paths <- function(dir_R = here::here()){

  project_name <- basename( rstudioapi::getActiveProject() )

  file_names_template <-
    glue::glue("##############################################################################-
## Script purpose: Single source of file path strings
#' Overview: Source this script to load all file path strings for your project
##############################################################################-

# Directories
dir_proj <- here::here()
dir_cloud <- here::here('cloud_{project_name}')
dir_data <- fs::path(dir_cloud, 'data')
dir_raw <- fs::path(dir_data, 'raw')
dir_munge <- here::here('munge')
dir_analysis <- here::here('analysis')
dir_reports <- fs::path(dir_cloud, 'reports')
")
    writeLines(file_names_template, fs::path(dir_R, "file_paths.R"))
  }