Consistent reset option (#100)

* Implement option to reset project in all create functions & re-order arguments for consistency

* Update reset documentation

R/createAnalysisProject.R

@@ -22,17 +22,17 @@
 createAnalysisProject <- function(name, title = NULL,
                                   folder = getwd(),
                                   initial_status = "wip",
+                                  dirs = c("data", "analysis", "outputs"),
                                   packagedeps = "packrat",
                                   git = TRUE,
-                                  reset = TRUE,
                                   external_setup = list(
                                     git_service = "GitHub",
                                     login = gh::gh_whoami()$login,
                                     private = FALSE,
                                     protocol = "ssh",
                                     ci_activation = "travis"
                                   ),
-                                  dirs = c("data", "analysis", "outputs")) {
+                                  reset = TRUE) {
   if (missing(name)) stop("name is required")
   if (!is.character(name)) stop("name has to be a character")
   if (nchar(name) < 2) stop("name needs to have at least two characters")
@@ -61,6 +61,10 @@ createAnalysisProject <- function(name, title = NULL,
     message(sprintf("Oops! An error was found and the `%s` directory was deleted", name)) # nolint
   }
   )
-  reset_proj(current_proj)
+
+  if (reset) {
+    reset_proj(current_proj)
+  }
+
   invisible(TRUE)
 }

R/createBasicProject.R

@@ -20,7 +20,7 @@
 #'  "travis" means calling \code{usethis::use_travis()} and adding the Travis
 #'  badge to the README.
 #'  }
-#' @param reset whether to reset the project to current project
+#' @param reset Whether to reset the project to current project
 #'
 #' @export
 #'
@@ -37,8 +37,7 @@
 #' list.files(file.path(folder, "doggos"))
 #' unlink(file.path(folder, "doggos"))
 #' }
-createBasicProject <- function(name,
-                               title = NULL,
+createBasicProject <- function(name, title = NULL,
                                folder = getwd(),
                                initial_status = "wip",
                                packagedeps = "checkpoint",

R/createPackageProject.R

@@ -22,8 +22,8 @@
 #'  \item \code{ci_activation} Only NULL, and "travis" are supported at the moment.
 #'  "travis" means calling \code{usethis::use_travis()} and adding the Travis
 #'  badge to the README.
-#'  }#' @param title "What the Project Does (One Line, Title Case)"
-#'              If NULL, a random one will be generated.
+#'  }
+#' @param reset Whether to reset the project to current project
 #'
 #' @export
 #'
@@ -33,7 +33,8 @@
 #' createPackageProject(
 #'   name = "doggos", title = "Counting cute dogs",
 #'   folder = folder,
-#'   git = TRUE, external_setup = NULL
+#'   git = TRUE, external_setup = NULL,
+#'   reset = TRUE
 #' )
 #' list.files(file.path(folder, "doggos"))
 #' unlink(file.path(folder, "doggos"))
@@ -51,7 +52,8 @@ createPackageProject <- function(name, title = NULL,
                                    private = FALSE,
                                    protocol = "ssh",
                                    ci_activation = "travis"
-                                 )) {
+                                 ),
+                                 reset = TRUE) {
   if (missing(name)) stop("name is required")
   if (!is.character(name)) stop("name has to be a character")
   if (nchar(name) < 2) stop("name needs to have at least two characters")
@@ -162,6 +164,10 @@ createPackageProject <- function(name, title = NULL,
     }
     )
   }
-  reset_proj(current_proj)
+
+  if (reset) {
+    reset_proj(current_proj)
+  }
+
   invisible(TRUE)
 }

R/createTrainingProject.R

@@ -23,7 +23,8 @@
 #' list.files(file.path(folder, "doggos"))
 #' unlink(file.path(folder, "doggos"))
 #' }
-createTrainingProject <- function(name, folder = getwd(),
+createTrainingProject <- function(name, title = NULL,
+                                  folder = getwd(),
                                   initial_status = "wip",
                                   dirs = c("data", "handouts", "slides"),
                                   handoutEngine = "rmarkdown",
@@ -37,7 +38,6 @@ createTrainingProject <- function(name, folder = getwd(),
                                     protocol = "ssh",
                                     ci_activation = "travis"
                                   ),
-                                  title = NULL,
                                   reset = TRUE) {
   if (missing(name)) stop("name is required")
   if (!is.character(name)) stop("name has to be a character")
@@ -135,7 +135,10 @@ createTrainingProject <- function(name, folder = getwd(),
   )
   setup_dep_system(packagedeps)
 
-  reset_proj(current_proj)
+  if (reset) {
+    reset_proj(current_proj)
+  }
+
   invisible(TRUE)
 }