Extend RcppArmadillo.package.skeleton

Author: eddelbuettel

ChangeLog

@@ -1,3 +1,9 @@
+2025-02-11  Dirk Eddelbuettel  <[email protected]>
+
+	* R/RcppArmadillo.package.skeleton.R: Generalise helper function to
+	support additional DESCRIPTION fields
+	* man/RcppArmadillo.package.skeleton.Rd: Document
+
 2025-02-05  Dirk Eddelbuettel  <[email protected]>
 
 	* DESCRIPTION (Version, Date): RcppArmadillo 14.2.3-1

R/RcppArmadillo.package.skeleton.R

@@ -1,6 +1,6 @@
 ## RcppArmadillo.package.skeleton.R: makes a skeleton for a package that wants to use RcppArmadillo
 ##
-## Copyright (C)  2010 - 2021  Dirk Eddelbuettel, Romain Francois and Douglas Bates
+## Copyright (C)  2010 - 2025  Dirk Eddelbuettel, Romain Francois and Douglas Bates
 ##
 ## This file is part of RcppArmadillo.
 ##
@@ -17,11 +17,17 @@
 ## You should have received a copy of the GNU General Public License
 ## along with RcppArmadillo.  If not, see <http://www.gnu.org/licenses/>.
 
-RcppArmadillo.package.skeleton <- function(name="anRpackage", list=character(),
-                                           environment=.GlobalEnv,
-                                           path=".", force=FALSE,
-                                           code_files=character(),
-                                           example_code=TRUE) {
+RcppArmadillo.package.skeleton <- function(name = "anRpackage", list = character(),
+                                           environment = .GlobalEnv,
+                                           path = ".", force = FALSE,
+                                           code_files = character(),
+                                           example_code = TRUE,
+                                           author = "Your Name",
+                                           maintainer = if (missing(author)) "Your Name"
+                                                        else author,
+                                           email = "[email protected]",
+                                           githubuser = NA_character_,
+                                           license = "GPL (>= 2)") {
 
     env <- parent.frame(1)              # #nocov start
 
@@ -67,9 +73,24 @@ RcppArmadillo.package.skeleton <- function(name="anRpackage", list=character(),
     ## Add Rcpp to the DESCRIPTION
     DESCRIPTION <- file.path(root, "DESCRIPTION")
     if (file.exists(DESCRIPTION)) {
+        splitname <- strsplit(author, " ")[[1]]
         x <- cbind(read.dcf(DESCRIPTION),
                    "Imports" = sprintf("Rcpp (>= %s)", packageDescription("Rcpp")[["Version"]]),
-                   "LinkingTo" = "Rcpp, RcppArmadillo")
+                   "LinkingTo" = "Rcpp, RcppArmadillo",
+                   "Authors@R" = sprintf("person(\"%s\", \"%s\", role = c(\"aut\", \"cre\"), email = \"%s\")",
+                                         paste(splitname[-length(splitname)], collapse=" "),
+                                         splitname[length(splitname)],
+                                         email),
+                   "License" = license,
+                   "Title" = "Concise Summary of What the Package Does",
+                   "Description" = "More about what it does (maybe more than one line).",
+                   "Version" = "0.0.1")
+        if (!is.na(githubuser)) {
+            x <- cbind(x, matrix("", 1, 1, dimnames=list("", "URL")))
+            x[1, "URL"] <- paste0("https://github.com/", githubuser, "/", name)
+            x <- cbind(x, matrix("", 1, 1, dimnames=list("", "BugReports")))
+            x[1, "BugReports"] <- paste0("https://github.com/", githubuser, "/", name, "/issues")
+        }
         write.dcf(x, file=DESCRIPTION)
         message(" >> added Imports: Rcpp")
         message(" >> added LinkingTo: Rcpp, RcppArmadillo")

man/RcppArmadillo.package.skeleton.Rd

@@ -4,16 +4,19 @@
 Create a skeleton for a new package that intends to use RcppArmadillo
 }
 \description{
-	\code{RcppArmadillo.package.skeleton} automates the creation of 
-	a new source package that intends to use features of RcppArmadilo. 
-	
+	\code{RcppArmadillo.package.skeleton} automates the creation of
+	a new source package that intends to use features of RcppArmadilo.
+
 	It is based on the \link[utils]{package.skeleton} function
 	which it executes first.
 }
 \usage{
-RcppArmadillo.package.skeleton(name = "anRpackage", list = character(), 
-	environment = .GlobalEnv, path = ".", force = FALSE, 
-	code_files = character(), example_code = TRUE)
+RcppArmadillo.package.skeleton(name = "anRpackage", list = character(),
+	environment = .GlobalEnv, path = ".", force = FALSE,
+	code_files = character(), example_code = TRUE, author = "Your Name",
+        maintainer = if (missing(author)) "Your Name" else author,
+        email = "[email protected]", githubuser = NA_character_,
+        license = "GPL (>= 2)")
 }
 \arguments{
 	\item{name}{See \link[utils]{package.skeleton}}
@@ -23,27 +26,32 @@ RcppArmadillo.package.skeleton(name = "anRpackage", list = character(),
 	\item{force}{See \link[utils]{package.skeleton}}
 	\item{code_files}{See \link[utils]{package.skeleton}}
 	\item{example_code}{If TRUE, example c++ code using RcppArmadillo is added to the package}
+       	\item{author}{Author of the package.}
+	\item{maintainer}{Maintainer of the package.}
+	\item{email}{Email of the package maintainer.}
+	\item{githubuser}{GitHub username for URL and BugReports, if present.}
+	\item{license}{License of the package.}
 }
 \details{
-	In addition to \link[utils]{package.skeleton} : 
-	
-	The \samp{DESCRIPTION} file gains a Depends line requesting that 
-	the package depends on Rcpp and RcppArmadillo and 
+	In addition to \link[utils]{package.skeleton} :
+
+	The \samp{DESCRIPTION} file gains a Depends line requesting that
+	the package depends on Rcpp and RcppArmadillo and
 	a LinkingTo line so that the package finds Rcpp and RcppArmadillo header files.
-	
+
 	The \samp{NAMESPACE}, if any, gains a \code{useDynLib} directive.
-	
-	The \samp{src} directory is created if it does not exists and 
+
+	The \samp{src} directory is created if it does not exists and
 	a \samp{Makevars} file is added setting the environment variable
 	\samp{PKG_LIBS} to accomodate the necessary flags
-	to link with the Rcpp library. 
-	
-	If the \code{example_code} argument is set to \code{TRUE}, 
+	to link with the Rcpp library.
+
+	If the \code{example_code} argument is set to \code{TRUE},
 	example files \samp{rcpparma_hello_world.h} and \samp{rcpparma_hello_world.cpp}
-	are also created in the \samp{src}. An R file \samp{rcpparma_hello_world.R} is 
+	are also created in the \samp{src}. An R file \samp{rcpparma_hello_world.R} is
 	expanded in the \samp{R} directory, the \code{rcpparma_hello_world} function
 	defined in this files makes use of the C++ function \samp{rcpparma_hello_world}
-	defined in the C++ file. These files are given as an example and should 
+	defined in the C++ file. These files are given as an example and should
 	eventually by removed from the generated package.
 }
 \value{
@@ -65,4 +73,3 @@ RcppArmadillo.package.skeleton( "foobar" )
 }
 }
 \keyword{ programming }
-