R/setup_project.R

In prodigenr: Research Project Directory Generator

#' Setup a standardized folder and file structure for a research analysis project.
#'
#' This starts the project by setting up a common folder and file infrastructure,
#' as well as adding some useful files to start the project. Also adds Git to the
#' project.
#'
#' @param path A path to a new directory.
#'
#' @return Project setup with folders and files necessary for a standard research project.
#' @export
#'
#' @examples
#' \dontrun{
#' # Use a temporary location
#' new_proj_name <- fs::path_temp("DiabetesCancer")
#' setup_project(new_proj_name)
#' # After the new project opens up, add Git with:
#' setup_with_git()
#' }
setup_project <-
  function(path) {
    stopifnot(is.character(path))
    proj_path <- fs::path_abs(path)
    proj_name <- fs::path_file(proj_path)

    if (grepl(" ", basename(proj_path))) {
      rlang::warn("Project name has a space in it, replacing with a dash (-).")
      proj_path <- path_remove_spaces(proj_path)
    }

    if (fs::dir_exists(proj_path)) {
      if (has_only_git(proj_path)) {
        cli::cli_alert_info("The project already has Git added, so we will skip setting up Git.")
      } else {
        cli::cli_abort(c(
          "The {.val {proj_path}} folder already exists, so project creation is canceled.",
          "i" = "Delete the folder or use another name (not {.val {proj_name}}) for your project."
        ))
      }
    }
    proj_template <- find_template("projects", "basic-analysis")
    fs::dir_copy(proj_template, new_path = proj_path, overwrite = TRUE)

    withr::with_dir(
      new = proj_path,
      code = {
        update_template("DESCRIPTION", data = list(ProjectName = proj_name))
        update_template("template-Rproj", paste0(proj_name, ".Rproj"))
        fs::file_delete("template-Rproj")
        fs::file_move("gitignore", ".gitignore")
        update_template("README.md", data = list(ProjectName = proj_name))
        if (!fs::dir_exists(".git")) {
          gert::git_init()
        }
      }
    )
  }

has_only_git <- function(path) {
  all(basename(fs::dir_ls(path, all = TRUE)) == ".git")
}

# Git setup functions -------------------------------------------

#' Setup Git to the project.
#'
#' Takes a lot of inspiration from the usethis `use_git()` function, except
#' it only adds Git and nothing more (doesn't commit, doesn't restart RStudio
#' automatically). Must run this function inside the project you created from
#' [setup_project()].
#'
#' @return Adds Git and `.gitignore` file to the project.
#' @export
#' @seealso [setup_project()] for starting the project.
#'
setup_with_git <- function() {
  if (!is_rproj_folder()) {
    cli::cli_abort(c("The folder does not contain an {.val .Rproj} file.",
      "i" = "Use while in the project made with {.code prodigenr::setup_project().}"
    ))
  }

  if (has_git()) {
    rlang::abort("The project already has Git added.")
  }

  gert::git_init()
  set_git_ignore_files()
  cli::cli_alert_info("You might need to restart RStudio to see the Git pane.")
  return(invisible(NULL))
}

# Utilities -----------------------------------------------------

set_git_ignore_files <- function() {
  base::writeLines(
    c(".Rhistory", ".RData", ".Rproj.user", ".Rbuildignore", ".DS_Store", ".quarto"),
    ".gitignore"
  )
}

path_remove_spaces <- function(path) {
  path_as_vector <- fs::path_split(path)[[1]]
  last_dir <- length(path_as_vector)
  path_as_vector[last_dir] <- gsub(" +", "-", path_as_vector[last_dir])
  fs::path_join(path_as_vector)
}