Choose template according to script name. Closes #16

Author: FrancoisGuillem

R/scripts.R

@@ -7,9 +7,12 @@
 #'   (optional) name of the script to create and/or open. This parameter can also include
 #'   the subfolder where to save the script (see examples).
 #' @param template
-#'   One of "analysis", "data" or "function". For new scripts, template to use.
-#'   prScript adds a few comments that encourage you to add comments and explain
-#'   what the script will do. These comments depend on the choosen template.
+#'   (Optional) One of "analysis", "data" or "function". Template to use for the
+#'   creation of a script. \code{prScript} adds a few comments that encourage the user to add
+#'   comments and explain what the script will do. These comments depend on the
+#'   choosen template. If the argument is missing, the choosen template depends
+#'   on the name of the script: "data" if the name begins with "data", "function"
+#'   if it start with "tools" and "analysis" in all other cases.
 #' @param subdir
 #'   subdirectory where the scripts needs to be created or opened. The 
 #'   subdirectory can also be directly specified in the parameter \code{name}.
@@ -39,7 +42,13 @@
 #' 
 #' @export
 #' 
-prScript <- function(name, template=c("analysis", "data", "function"), subdir = ".") {
+prScript <- function(name, template, subdir = ".") {
+  if (missing(template)) {
+    if (grepl("^data", name, ignore.case = TRUE)) template <- "data"
+    else if (grepl("^tools", name, ignore.case = TRUE)) template <- "function"
+    else template <- "analysis"
+  }
+  
   template <- match.arg(template[1], 
                         c("analysis", "data", "function", "main", "start"))
 

inst/scriptTemplates/analysis.brew

@@ -4,7 +4,7 @@
 #
 #////////
 # GOAL:
-# what is the goal of this project ?
+# what is the question this script tries to answer ?
 #
 #////////
 # APPROACH:

inst/scriptTemplates/data.brew

@@ -8,11 +8,12 @@
 #
 #////////
 # OUTPUT:
-# what objects will the script create ?
+# what data objects will the script create ?
 #
 #////////
 # DETAILS:
-# Anything else ?
+# Anything else ? Where did you get the data ? Did you do some manual
+# transformation ?
 #
 #///////////////////////////////////////////////////////////////////////////////
 

inst/scriptTemplates/function.brew

@@ -4,7 +4,7 @@
 #
 #////////
 # DESCRIPTION:
-# what do the function ?
+# what does the function do ?
 #
 #////////
 # ARGS:
@@ -14,7 +14,7 @@
 #
 #////////
 # RETURNS:
-# Anything else ?
+# what is the result of the function ?
 #
 #////////
 # EXAMPLES:

inst/scriptTemplates/start.brew

@@ -5,10 +5,6 @@
 # This script is sourced when you open the project. Load libraries with 
 # "prLibrary". Load data with "prLoad" and source files with "prSource".
 #
-#////////
-# DETAILS:
-# Anything special ?
-#
 #///////////////////////////////////////////////////////////////////////////////