From 71a61055ed0b638465f44bfd1984e721550fe327 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ma=C3=ABlle=20Salmon?= Date: Thu, 8 Nov 2018 17:22:44 +0100 Subject: [PATCH] docs fixing --- R/createPackageProject.R | 7 ++++++- man/createPackageProject.Rd | 5 +++++ 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/R/createPackageProject.R b/R/createPackageProject.R index 19ec6fa..d35c4cf 100644 --- a/R/createPackageProject.R +++ b/R/createPackageProject.R @@ -2,7 +2,10 @@ #' commands executed to save you hassle #' #' @param name Project / package name +#' @param title "What the Project Does (One Line, Title Case)" +#' If NULL, a random one will be generated. #' @param folder Folder under which to create the project +#' @param git Configure Git #' @param bestPractices Run additional best practice commands #' @param coverage What code coverage platform to use, "codecov" or "coveralls". #' @param external_setup How to do the partly interactive setup @@ -87,7 +90,9 @@ createPackageProject <- function(name, title = NULL, usethis::use_readme_rmd(open = FALSE) usethis::use_testthat() usethis::use_vignette(name) - usethis::use_git(message = cool_first_commit()) + if(git){ + usethis::use_git(message = cool_first_commit()) + } if (!is.null(external_setup)){ setup_repo( diff --git a/man/createPackageProject.Rd b/man/createPackageProject.Rd index efe6ae1..ede24d0 100644 --- a/man/createPackageProject.Rd +++ b/man/createPackageProject.Rd @@ -14,12 +14,17 @@ createPackageProject(name, title = NULL, folder = getwd(), \arguments{ \item{name}{Project / package name} +\item{title}{"What the Project Does (One Line, Title Case)" +If NULL, a random one will be generated.} + \item{folder}{Folder under which to create the project} \item{bestPractices}{Run additional best practice commands} \item{coverage}{What code coverage platform to use, "codecov" or "coveralls".} +\item{git}{Configure Git} + \item{external_setup}{How to do the partly interactive setup of online git, CI and coverage platforms. If NULL, no setup. \itemize{