R/new_project.R

In ghiggi/ProjectTemplate: What the Package Does

#' Create new project scaffolding.
#'#'
#' @param name Name of the new project. A new folder will be created with that name.
#' @param github Logical. Create GitHub repo? Note this requires a \code{GITHUB_PAT}. See \code{\link[devtools]{use_github}}.
#' @param private.repo Logical. Default is TRUE.
#' @param travis Logical. Set Travis? If TRUE, a badge will be added automatically to README.Rmd. But the project will need to be activated at \url{https://travis-ci.org/profile}.
#'
#' @return A new directory with R package structure, slightly modified.
#' @export
#' @import devtools
#' @details Inspired based on Template package \url{https://github.com/Pakillo/template/}.
new_project <- function(name, github = FALSE, private.repo = TRUE, travis = FALSE){
  devtools::create(name)
  try(use_package_doc(name), silent = TRUE)
  try(use_readme_rmd(name), silent = TRUE)
  use_data_raw(name)
  use_testthat(name)
  
  dir.create(file.path(name, "data"))
  dir.create(file.path(name, "data\raw"))
  dir.create(file.path(name, "data\clean"))
  dir.create(file.path(name, "data\final"))
  dir.create(file.path(name, "data\temp"))
  dir.create(file.path(name, "docs"))
  dir.create(file.path(name, "docs\man"))
  dir.create(file.path(name, "docs\vignettes"))
  dir.create(file.path(name, "figs"))
  dir.create(file.path(name, "manuscript"))
  dir.create(file.path(name, "R"))
  dir.create(file.path(name, "scripts"))
  dir.create(file.path(name, "src"))
  dir.create(file.path(name, "tests"))
  # Specify folders to not syncronize with git
  # cat("\n^figs$ \n^manuscript$ \n", sep = "",
      file = file.path(name, ".Rbuildignore"), append = TRUE)

  if (github){
    use_github(pkg = name, private = private.repo)
    use_github_links(name)

    if (travis){
      use_travis(name)
      cat("\n\n\n[![Travis-CI Build Status](https://travis-ci.org/",
          devtools:::github_info(name)$username, "/",
          name, ".svg?branch=master)](https://travis-ci.org/",
          devtools:::github_info(name)$username, "/", name, ")",
          file = file.path(name, "README.Rmd"), sep = "", append = TRUE)

    }

  }

}