R/project_structure.R

In janbrederecke/prepareD: Functions that help to prepare data before analysis

#' @title project_structure
#'
#' @description Creates a project structure in the current working directory.
#'
#' @param .path A character vector containing the path to the project.
#' @param .template Defaults to "basic". Character vector that can be used to
#' choose user-defined templates that have been saved to
#' "system.file/templates".
#' @param .data_folder Logical. If TRUE, a folder of name 'data' with
#' subdirectories 'raw' and 'clean' is created in the root folder of the current
#' project.
#'
#' @return A character vector with the numeric variables.
#' @examples -
#' @export

project_structure <- function(.path = ""
                              , .template = "basic"
                              , .data_folder = TRUE
){

  # Check the path
  if (.path == "") {
    .path <- getwd()
  }

  # Copy the template files to the current working directory
  all_files <- list.files(system.file(paste0("templates/", .template),
                                      package = "prepareD"),
                          full.names = TRUE)
  file.copy(from = all_files, to = .path, overwrite = TRUE,
            recursive = TRUE)

  # Create empty data folders that cannot be included in the template
  if (.data_folder == TRUE) {
  dir.create(paste0(.path, "/data"))
  dir.create(paste0(.path, "/data/raw"))
  dir.create(paste0(.path, "/data/clean"))
  }
}