Hadley-fication

DESCRIPTION

@@ -12,7 +12,7 @@ Imports:
     utils,
     tools,
     memoise,
-    brew
+    whisker
 Suggests:
     testthat,
     roxygen2,
@@ -64,5 +64,3 @@ Collate:
     'inst.r'
     'metadata.r'
     'create.r'
-    'create-package-doc.r'
-    'save-package-description.R'

NAMESPACE

@@ -9,7 +9,6 @@ export(check_doc)
 export(check)
 export(clean_source)
 export(clean_vignettes)
-export(create_package_doc)
 export(create)
 export(dev_meta)
 export(dev_mode)
@@ -41,7 +40,6 @@ export(revdep_check)
 export(revdep_maintainers)
 export(revdep)
 export(run_examples)
-export(save_package_description)
 export(set_path)
 export(show_news)
 export(show_rd)
@@ -58,7 +56,6 @@ export(with_locale)
 export(with_options)
 export(with_par)
 export(with_path)
-importFrom(brew,brew)
 importFrom(httr,config)
 importFrom(httr,content)
 importFrom(httr,GET)
@@ -71,3 +68,4 @@ importFrom(tools,file_ext)
 importFrom(tools,package_dependencies)
 importFrom(tools,Rd2txt)
 importFrom(utils,install.packages)
+importFrom(whisker,whisker.render)

R/create.r

@@ -1,50 +1,64 @@
 #' Creates a new package, following all devtools package conventions.
 #'
-#' @param name character string: the package name and directory name for
-#'        your package.
-#' @param path to put the package directory in
-#' @param description list of description values to override default values or add additional values.
+#' Similar to \code{\link{package.skeleton}}, except that it only creates
+#' the standard devtools directory structures, it doesn't try and create 
+#' source code and data files by inspecting the global environment.
+#'
+#' @param path location to create new package.  The last component of the path
+#'   will be used as the package name.
+#' @param description list of description values to override default values or
+#'   add additional values.
+#' @param ... other options passed to \code{package.skeleton}
 #' @seealso Text with \code{\link{package.skeleton}}
 #' @export
 #' @examples
-#'
 #' # Create a package using all defaults:
-#' path_to_package <- tempdir()
-#' create(name='myDefaultPackage', path=path_to_package)
+#' path <- file.path(tempdir(), "myDefaultPackage")
+#' create(path)
 #'
 #' # Override a description attribute.
-#' # Note that overriding one atribute implies that you must override
-#' # all default attributes, as well.
-#' my_description <- list("Maintainer"="'Yoni Ben-Meshulam' <yoni@@opower.com>")
-#' create(name='myCustomPackage', path=path_to_package, description=my_description)
-create <- function(
-                   name,
-                   path,
-                   description=list()
-                   ) {
+#' path <- file.path(tempdir(), "myCustomPackage")
+#' my_description <- list("Maintainer" = 
+#'   "'Yoni Ben-Meshulam' <yoni@@opower.com>")
+#' create("../myCustomPackage", my_description)
+create <- function(path, description = list()) {
+  name <- basename(path)
+  message("Creating package ", name, " in ", dirname(path))
 
-  description.defaults <- list(
-                            Package=name,
-                            Maintainer="Who to complain to <yourfault@somewhere.net>",
-                            Author=Sys.getenv("USER"),
-                            Version="1.0",
-                            License="GPL-3",
-                            Title=name,
-                            Description=name,
-                            Suggests="\ntestthat,\nroxygen2"
-                            )
+  if (file.exists(path)) {
+    stop("Directory already exists", call. = FALSE)
+  }
+  if (!file.exists(dirname(path))) {
+    stop("Parent directory does not exist.", call. = FALSE)
+  }
 
-  package_path <- file.path(path, name)
-  message(sprintf("Creating package [%s] in path [%s]", name, package_path))
+  dir.create(path)
 
-  dir.create(package_path)
-  dir.create(file.path(package_path, 'R'))
+  defaults <- list(
+    Package = name,
+    Maintainer = "Who to complain to <yourfault@somewhere.net>",
+    Author = Sys.getenv("USER"),
+    Version = "1.0",
+    License = "GPL-3",
+    Title = "",
+    Description = "",
+    Suggests = "\ntestthat,\nroxygen2"
+  )
+  description <- modifyList(defaults, description)
+  write.dcf(description, file.path(path, 'DESCRIPTION'))
+
+  dir.create(file.path(path, "R"))
+  create_package_doc(path, name)
 
-  description <- modifyList(description.defaults, description)
-
-  save_package_description(package_path, description)
-  create_package_doc(package_path, name)
+  check(path)
+}
 
-  check(package_path)
+#' @importFrom whisker whisker.render
+create_package_doc <- function(path, name) {
+  template <- readLines(system.file("templates", "packagename-package.r",
+    package = "devtools"))
+  out <- whisker.render(template, list(name = name))
 
+  target <- file.path(path, "R", paste(name, "-package.r", sep = ""))
+  writeLines(out, target)
 }

README.md

@@ -38,7 +38,9 @@ Building and installing:
   arbitrary url. `install_version` installs a specified version from cran,
 
 Creating a new package:
-* `create("pkg")` creates a new R package, followint all devtools conventions.
+
+* `create("path/to/pkg")` creates a new R package following devtools
+  conventions. called `pkg` in `path/to`,
 
 Check and release:
 

inst/templates/packagename-package.r

@@ -1,8 +1,5 @@
-#' <%= name %>
+#' {{{ name }}}
 #' 
-#' @name <%= name %>-package
-#' @aliases <%= name %>
+#' @name {{{ name }}}
 #' @docType package
-#' @title <%= name %>
-#' @keywords package
 NULL

man/create.Rd

@@ -2,31 +2,34 @@
 \alias{create}
 \title{Creates a new package, following all devtools package conventions.}
 \usage{
-  create(name, path, description = list())
+  create(path, description = list())
 }
 \arguments{
-  \item{name}{character string: the package name and
-  directory name for your package.}
-
-  \item{path}{to put the package directory in}
+  \item{path}{location to create new package.  The last
+  component of the path will be used as the package name.}
 
   \item{description}{list of description values to override
   default values or add additional values.}
+
+  \item{...}{other options passed to
+  \code{package.skeleton}}
 }
 \description{
-  Creates a new package, following all devtools package
-  conventions.
+  Similar to \code{\link{package.skeleton}}, except that it
+  only creates the standard devtools directory structures,
+  it doesn't try and create source code and data files by
+  inspecting the global environment.
 }
 \examples{
 # Create a package using all defaults:
-path_to_package <- tempdir()
-create(name='myDefaultPackage', path=path_to_package)
+path <- file.path(tempdir(), "myDefaultPackage")
+create(path)
 
 # Override a description attribute.
-# Note that overriding one atribute implies that you must override
-# all default attributes, as well.
-my_description <- list("Maintainer"="'Yoni Ben-Meshulam' <yoni@opower.com>")
-create(name='myCustomPackage', path=path_to_package, description=my_description)
+path <- file.path(tempdir(), "myCustomPackage")
+my_description <- list("Maintainer" =
+  "'Yoni Ben-Meshulam' <yoni@opower.com>")
+create("../myCustomPackage", my_description)
 }
 \seealso{
   Text with \code{\link{package.skeleton}}