Merge pull request #54 from jangorecki/packages-fields

fields argument to insertPackage, closes #53
eddelbuettel · Aug 1, 2016 · e81e550 · e81e550
2 parents 0cb0026 + 37a0cb7
commit e81e550
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 11 deletions.
diff --git a/R/insertPackage.R b/R/insertPackage.R
@@ -31,8 +31,8 @@
 ##' previous versions), \dQuote{archive} (place any previous versions into 
 ##' a package-specific archive folder, creating such an archive if it does 
 ##' not already exist), or \dQuote{prune} (calling \code{\link{pruneRepo}}).
-##' @param ... For the aliases variant, a catch-all collection of
-##' parameters.
+##' @param ... For \code{insert} the aliases variant, a catch-all collection of
+##' parameters. For \code{insertPackage} arguments passed to \code{write_PACKAGES}.
 ##' @return NULL is returned.
 ##' @examples
 ##' \dontrun{
@@ -48,7 +48,8 @@ insertPackage <- function(file,
                           repodir=getOption("dratRepo", "~/git/drat"),
                           commit=FALSE,
                           pullfirst=FALSE,
-                          action=c("none", "archive", "prune")) {
+                          action=c("none", "archive", "prune"),
+                          ...) {
 
     if (!file.exists(file)) stop("File ", file, " not found\n", call.=FALSE)
 
@@ -99,7 +100,7 @@ insertPackage <- function(file,
     }
 
     ## update index
-    write_PACKAGES(pkgdir, type=pkgtype)
+    write_PACKAGES(pkgdir, type=pkgtype, ...)
 
     if (commit) {
         if (haspkg) {

diff --git a/man/insertPackage.Rd b/man/insertPackage.Rd
@@ -8,7 +8,7 @@
 \usage{
 insertPackage(file, repodir = getOption("dratRepo", "~/git/drat"),
   commit = FALSE, pullfirst = FALSE, action = c("none", "archive",
-  "prune"))
+  "prune"), ...)
 
 insert(...)
 }
@@ -25,14 +25,14 @@ implies the \sQuote{TRUE} values in other contexts.}
 
 \item{pullfirst}{Boolean toggle to call \code{git pull} before inserting the package.}
 
-\item{action}{A character string containing one of: \dQuote{none}
-(the default; add the new package into the repo, effectively masking
-previous versions), \dQuote{archive} (place any previous versions into
-a package-specific archive folder, creating such an archive if it does
+\item{action}{A character string containing one of: \dQuote{none} 
+(the default; add the new package into the repo, effectively masking 
+previous versions), \dQuote{archive} (place any previous versions into 
+a package-specific archive folder, creating such an archive if it does 
 not already exist), or \dQuote{prune} (calling \code{\link{pruneRepo}}).}
 
-\item{...}{For the aliases variant, a catch-all collection of
-parameters.}
+\item{...}{For \code{insert} the aliases variant, a catch-all collection of
+parameters. For \code{insertPackage} it passed to \code{write_PACKAGES}.}
 }
 \value{
 NULL is returned.