Merge pull request #471 from RcppCore/feature/update-pkg-skeleton

update Rcpp.package.skeleton()

Author: jjallaire

ChangeLog

@@ -1,3 +1,18 @@
+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
+        satisfy R CMD check in R-release and (current) R-devel
+
 2016-05-08  Dirk Eddelbuettel  <[email protected]>
 
         * inst/unitTests/cpp/Matrix.cpp: Made four scalar/matrix tests less

R/Rcpp.package.skeleton.R

@@ -1,6 +1,4 @@
-# -*- tab-width: 4; -*-
-
-# Copyright (C) 2009 - 2015  Dirk Eddelbuettel and Romain Francois
+# Copyright (C) 2009 - 2016  Dirk Eddelbuettel and Romain Francois
 #
 # This file is part of Rcpp.
 #
@@ -30,74 +28,77 @@ 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)
 
-	if (!is.character(cpp_files))
-		stop("'cpp_files' must be a character vector")
+    if (!is.character(cpp_files))
+        stop("'cpp_files' must be a character vector")
 
-	if (!length(list)) {
-		fake <- TRUE
-		assign("Rcpp.fake.fun", function() {}, envir = env)
-		if (example_code && !isTRUE(attributes)) {
-			assign("rcpp_hello_world", function() {}, envir = env)
-			remove_hello_world <- TRUE
-		} else {
+    if (!length(list)) {
+        fake <- TRUE
+        assign("Rcpp.fake.fun", function() {}, envir = env)
+        if (example_code && !isTRUE(attributes)) {
+            assign("rcpp_hello_world", function() {}, envir = env)
+            remove_hello_world <- TRUE
+        } else {
             remove_hello_world <- FALSE
-		}
-	} else {
+        }
+    } else {
         if (example_code && !isTRUE(attributes)) {
             if (!"rcpp_hello_world" %in% list) {
                 assign( "rcpp_hello_world", function() {}, envir = env)
                 call[["list"]] <- as.call(c(as.name("c"),
                                             as.list(c("rcpp_hello_world", list))))
             }
-			remove_hello_world <- TRUE
-		} else {
-			remove_hello_world <- FALSE
-		}
-		fake <- FALSE
-	}
+            remove_hello_world <- TRUE
+        } else {
+            remove_hello_world <- FALSE
+        }
+        fake <- FALSE
+    }
 
     ## first let the traditional version do its business
-	## remove Rcpp specific arguments
+    ## remove Rcpp specific arguments
 
-	call <- call[ c(1L, which(names(call) %in% names(formals(package.skeleton)))) ]
+    call <- call[ c(1L, which(names(call) %in% names(formals(package.skeleton)))) ]
 
-	if (fake) {
-		call[["list"]] <- c(if(isTRUE(example_code)
+    if (fake) {
+        call[["list"]] <- c(if(isTRUE(example_code)
                                && !isTRUE(attributes)) "rcpp_hello_world", "Rcpp.fake.fun")
-	}
+    }
 
-	tryCatch(eval(call, envir = env), error = function(e){
-		stop(sprintf("error while calling `package.skeleton` : %s", conditionMessage(e)))
-	})
+    tryCatch(eval(call, envir = env), error = function(e){
+        stop(sprintf("error while calling `package.skeleton` : %s", conditionMessage(e)))
+    })
 
-	message("\nAdding Rcpp settings")
+    message("\nAdding Rcpp settings")
 
-	## now pick things up
-	root <- file.path(path, name)
+    ## now pick things up
+    root <- file.path(path, name)
 
-	# Add Rcpp to the DESCRIPTION
-	DESCRIPTION <- file.path(root, "DESCRIPTION")
-	if (file.exists(DESCRIPTION)) {
-		imports <- c(if (isTRUE(module)) "methods",
+    # Add Rcpp to the DESCRIPTION
+    DESCRIPTION <- file.path(root, "DESCRIPTION")
+    if (file.exists(DESCRIPTION)) {
+        imports <- c(if (isTRUE(module)) "methods",
                      sprintf("Rcpp (>= %s)", packageDescription("Rcpp")[["Version"]]))
-		x <- cbind(read.dcf(DESCRIPTION),
+        x <- cbind(read.dcf(DESCRIPTION),
                    "Imports" = paste(imports, collapse = ", "),
                    "LinkingTo" = "Rcpp")
-		x[, "Author"] <- author
-		x[, "Maintainer"] <- sprintf("%s <%s>", maintainer, email)
-		x[, "License"] <- license
-		message( " >> added Imports: Rcpp" )
-		message( " >> added LinkingTo: Rcpp" )
-		write.dcf(x, file = DESCRIPTION)
+        x[, "Author"] <- author
+        x[, "Maintainer"] <- sprintf("%s <%s>", maintainer, email)
+        x[, "License"] <- license
+        x[, "Title"] <- "What the Package Does in One 'Title Case' Line"
+        x[, "Description"] <- "One paragraph description of what the package does as one or more full sentences."
+        message( " >> added Imports: Rcpp" )
+        message( " >> added LinkingTo: Rcpp" )
+        write.dcf(x, file = DESCRIPTION)
 
-	}
+    }
 
-	## add useDynLib and importFrom to NAMESPACE
-	NAMESPACE <- file.path(root, "NAMESPACE")
+    ## add useDynLib and importFrom to NAMESPACE
+    NAMESPACE <- file.path(root, "NAMESPACE")
     lines <- readLines(NAMESPACE)
     ns <- file(NAMESPACE, open="w")
     if (! grepl("useDynLib", lines)) {
@@ -114,98 +115,109 @@ Rcpp.package.skeleton <- function(name = "anRpackage", list = character(),
     }
     close( ns )
 
-	## update the package description help page
+    ## update the package description help page
     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
-	src <- file.path(root, "src")
-	if (!file.exists(src)) {
-		dir.create(src)
-	}
-	skeleton <- system.file("skeleton", package = "Rcpp")
-	
-	if (length(cpp_files) > 0L) {
-		for (file in cpp_files) {
-			file.copy(file, src)
-			message(" >> copied ", file, " to src directory" )
-		}
-		compileAttributes(root)
-	}
-
-	if (example_code) {
-		if (isTRUE(attributes)) {
-			file.copy(file.path( skeleton, "rcpp_hello_world_attributes.cpp"),
+    ## lay things out in the src directory
+    src <- file.path(root, "src")
+    if (!file.exists(src)) {
+        dir.create(src)
+    }
+    skeleton <- system.file("skeleton", package = "Rcpp")
+    
+    if (length(cpp_files) > 0L) {
+        for (file in cpp_files) {
+            file.copy(file, src)
+            message(" >> copied ", file, " to src directory" )
+        }
+        compileAttributes(root)
+    }
+
+    if (example_code) {
+        if (isTRUE(attributes)) {
+            file.copy(file.path( skeleton, "rcpp_hello_world_attributes.cpp"),
                       file.path( src, "rcpp_hello_world.cpp"))
-			message(" >> added example src file using Rcpp attributes")
-			compileAttributes(root)
-			message(" >> compiled Rcpp attributes")
-		} else {
-			header <- readLines(file.path(skeleton, "rcpp_hello_world.h"))
-			header <- gsub("@PKG@", name, header, fixed = TRUE)
-			writeLines(header , file.path(src, "rcpp_hello_world.h"))
-			message(" >> added example header file using Rcpp classes")
-
-			file.copy(file.path(skeleton, "rcpp_hello_world.cpp"), src)
-			message(" >> added example src file using Rcpp classes")
-
-			rcode <- readLines(file.path( skeleton, "rcpp_hello_world.R"))
-			rcode <- gsub("@PKG@", name, rcode, fixed = TRUE)
-			writeLines( rcode , file.path( root, "R", "rcpp_hello_world.R"))
-			message(" >> added example R file calling the C++ example")
-		}
-
-		hello.Rd <- file.path(root, "man", "rcpp_hello_world.Rd")
-		unlink(hello.Rd)
-		file.copy(system.file("skeleton", "rcpp_hello_world.Rd", package = "Rcpp"), hello.Rd)
-		message( " >> added Rd file for rcpp_hello_world")
-	}
-
-	if (isTRUE(module)) {
-		file.copy(system.file("skeleton", "rcpp_module.cpp", package="Rcpp"),
+            message(" >> added example src file using Rcpp attributes")
+            compileAttributes(root)
+            message(" >> compiled Rcpp attributes")
+        } else {
+            header <- readLines(file.path(skeleton, "rcpp_hello_world.h"))
+            header <- gsub("@PKG@", name, header, fixed = TRUE)
+            writeLines(header , file.path(src, "rcpp_hello_world.h"))
+            message(" >> added example header file using Rcpp classes")
+
+            file.copy(file.path(skeleton, "rcpp_hello_world.cpp"), src)
+            message(" >> added example src file using Rcpp classes")
+
+            rcode <- readLines(file.path( skeleton, "rcpp_hello_world.R"))
+            rcode <- gsub("@PKG@", name, rcode, fixed = TRUE)
+            writeLines( rcode , file.path( root, "R", "rcpp_hello_world.R"))
+            message(" >> added example R file calling the C++ example")
+        }
+
+        hello.Rd <- file.path(root, "man", "rcpp_hello_world.Rd")
+        unlink(hello.Rd)
+        file.copy(system.file("skeleton", "rcpp_hello_world.Rd", package = "Rcpp"), hello.Rd)
+        message( " >> added Rd file for rcpp_hello_world")
+    }
+
+    if (isTRUE(module)) {
+        file.copy(system.file("skeleton", "rcpp_module.cpp", package="Rcpp"),
                   file.path(root, "src"))
-		file.copy(system.file("skeleton", "Num.cpp", package="Rcpp"),
+        file.copy(system.file("skeleton", "Num.cpp", package="Rcpp"),
                   file.path(root, "src"))
-		file.copy(system.file("skeleton", "stdVector.cpp", package="Rcpp"),
+        file.copy(system.file("skeleton", "stdVector.cpp", package="Rcpp"),
                   file.path(root, "src"))
-		file.copy(system.file("skeleton", "zzz.R", package ="Rcpp"),
+        file.copy(system.file("skeleton", "zzz.R", package ="Rcpp"),
                   file.path(root, "R"))
-		file.copy(system.file("skeleton", "Rcpp_modules_examples.Rd", package ="Rcpp"),
+        file.copy(system.file("skeleton", "Rcpp_modules_examples.Rd", package ="Rcpp"),
                   file.path(root, "man"))
-		message(" >> copied the example module file ")
-	}
+        message(" >> copied the example module file ")
+    }
+
+    lines <- readLines(package.doc <- file.path( root, "man", sprintf("%s-package.Rd", name)))
+    lines <- sub("~~ simple examples", "%% ~~ simple examples", lines)
 
-	lines <- readLines(package.doc <- file.path( root, "man", sprintf("%s-package.Rd", name)))
-	lines <- sub("~~ simple examples", "%% ~~ simple examples", lines)
+    lines <- lines[! grepl("~~ package title", lines)]
+    lines <- lines[! grepl("~~ The author and", lines)]
+    lines <- sub("Who wrote it", author, lines )
+    lines <- sub("Who to complain to.*", sprintf("%s <%s>", maintainer, email), lines)
 
-	lines <- lines[! grepl("~~ package title", lines)]
-	lines <- lines[! grepl("~~ The author and", lines)]
-	lines <- sub("Who wrote it", author, lines )
-	lines <- sub("Who to complain to.*", sprintf("%s <%s>", maintainer, email), lines)
+    writeLines(lines, package.doc)
 
-	writeLines(lines, package.doc)
+    if (fake) {
+        rm("Rcpp.fake.fun", envir = env)
+        unlink(file.path(root, "R"  , "Rcpp.fake.fun.R"))
+        unlink(file.path(root, "man", "Rcpp.fake.fun.Rd"))
+    }
 
-	if (fake) {
-		rm("Rcpp.fake.fun", envir = env)
-		unlink(file.path(root, "R"  , "Rcpp.fake.fun.R"))
-		unlink(file.path(root, "man", "Rcpp.fake.fun.Rd"))
-	}
+    if (isTRUE(remove_hello_world)) {
+        rm("rcpp_hello_world", envir = env)
+    }
 
-	if (isTRUE(remove_hello_world)) {
-		rm("rcpp_hello_world", envir = env)
-	}
+    invisible(NULL)
+}
 
-	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

@@ -23,6 +23,12 @@
       \item The (older) \code{loadRcppModules()} is now deprecated in favour of
       \code{loadModule()} introduced around R 2.15.1 and Rcpp 0.9.11.
     }
+    \item Changes in Rcpp support functions:
+    \itemize{
+      \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.   
+  }
+}