further improvements to Rcpp.package.skeleton

Author: eddelbuettel

ChangeLog

@@ -1,3 +1,13 @@
+2016-05-11  Dirk Eddelbuettel  <[email protected]>
+
+        * R/Rcpp.package.skeleton.R: Modified to create a package without notes,
+        warnings, or error even pkgKitten is not available
+
+        * R/Rcpp.package.skeleton.R (.playWithPerPackageHelpPage): Added new
+        helper function to be used when pkgKitten is not available
+        * inst/skeleton/manual-page-stub.Rd: Stub for per-package help page used
+        when pkgKitten is not available
+
 2016-05-10  Dirk Eddelbuettel  <[email protected]>
 
         * R/Rcpp.package.skeleton.R: Also correct Title: and Description: to

R/Rcpp.package.skeleton.R

@@ -28,6 +28,7 @@ Rcpp.package.skeleton <- function(name = "anRpackage", list = character(),
 
     havePkgKitten <- requireNamespace("pkgKitten", quietly=TRUE)
 
+    
     call <- match.call()
     call[[1]] <- as.name("package.skeleton")
     env <- parent.frame(1)
@@ -118,16 +119,7 @@ Rcpp.package.skeleton <- function(name = "anRpackage", list = character(),
     if (havePkgKitten) {                # if pkgKitten is available, use it
         pkgKitten::playWithPerPackageHelpPage(name, path, maintainer, email)
     } else {
-        package_help_page <- file.path(root, "man", sprintf( "%s-package.Rd", name))
-        if (file.exists(package_help_page)) {
-            lines <- readLines(package_help_page)
-            lines <- gsub("What license is it under?", license, lines, fixed = TRUE)
-            lines <- gsub("Who to complain to <[email protected]>",
-                          sprintf( "%s <%s>", maintainer, email),
-                          lines, fixed = TRUE)
-            lines <- gsub( "Who wrote it", author, lines, fixed = TRUE)
-            writeLines(lines, package_help_page)
-        }
+        .playWithPerPackageHelpPage(name, path, maintainer, email) 
     }
 
     ## lay things out in the src directory
@@ -209,3 +201,23 @@ Rcpp.package.skeleton <- function(name = "anRpackage", list = character(),
 
     invisible(NULL)
 }
+
+## Borrowed with love from pkgKitten, and modified slightly
+.playWithPerPackageHelpPage <- function(name = "anRpackage",
+                                        path = ".",
+                                        maintainer = "Your Name",
+                                        email = "[email protected]") {
+    root <- file.path(path, name)    
+    helptgt <- file.path(root, "man", sprintf( "%s-package.Rd", name))
+    helpsrc <- system.file("skeleton", "manual-page-stub.Rd", package="Rcpp")
+    ## update the package description help page
+    if (file.exists(helpsrc)) {
+        lines <- readLines(helpsrc)
+        lines <- gsub("__placeholder__", name, lines, fixed = TRUE)
+        lines <- gsub("Who to complain to <[email protected]>",
+                      sprintf( "%s <%s>", maintainer, email),
+                      lines, fixed = TRUE)
+        writeLines(lines, helptgt)
+    }
+    invisible(NULL)
+}

inst/NEWS.Rd

@@ -25,9 +25,9 @@
     }
     \item Changes in Rcpp support functions:
     \itemize{
-      \item The \code{Rcpp.package.skeleton()} function was once again updated
-      in order to create a \code{DESCRIPTION} file  which passes
-      \code{R CMD check} without warnings under R-release and R-devel.
+      \item The \code{Rcpp.package.skeleton()} function was again updated in
+      order to create a \code{DESCRIPTION} file which passes \code{R CMD check}
+      without notes. warnings, or error under R-release and R-devel.
     }
   }
 }

inst/skeleton/manual-page-stub.Rd

@@ -0,0 +1,34 @@
+\name{__placeholder__-package}
+\alias{__placeholder__-package}
+\alias{__placeholder__}
+\docType{package}
+\title{
+  A short title line describing what the package does
+}
+\description{
+  A more detailed description of what the package does. A length
+  of about one to five lines is recommended.
+}
+\details{
+  This section should provide a more detailed overview of how to use the
+  package, including the most important functions.
+}
+\author{
+Who wrote it, email optional.
+
+Maintainer: Who to complain to <yourfault@somewhere.net>
+}
+\references{
+  This optional section can contain literature or other references for
+  background information.
+}
+\keyword{ package }
+\seealso{
+  Optional links to other man pages
+}
+\examples{
+  \dontrun{
+     ## Optional simple examples of the most important functions
+     ## These can be in \dontrun{} and \donttest{} blocks.   
+  }
+}