Export RCMD function so it can be used in other packages.

NAMESPACE

@@ -26,6 +26,7 @@ S3method(remote_metadata,url_remote)
 S3method(replay_stop,default)
 S3method(replay_stop,error)
 S3method(replay_stop,list)
+export(RCMD)
 export(add_path)
 export(add_rstudio_project)
 export(add_test_infrastructure)
@@ -108,6 +109,7 @@ export(show_news)
 export(source_gist)
 export(source_url)
 export(submit_cran)
+export(system_check)
 export(test)
 export(unload)
 export(use_appveyor)

NEWS.md

@@ -1,5 +1,7 @@
 # devtools 1.7.1.9000
 
+* export functions `RCMD()` and `system_check()` so they can be used by other packages. (@jimhester, #699).
+
 # devtools 1.7.0
 
 ## Improve reverse dependency checking

R/R.r

@@ -12,6 +12,16 @@ R <- function(options, path = tempdir(), env_vars = NULL, ...) {
   in_dir(path, system_check(r_path, options, c(r_env_vars(), env_vars), ...))
 }
 
+#' Run R CMD xxx from within R
+#'
+#' @param cmd one of the R tools available from the R CMD interface.
+#' @param options a charater vector of options to pass to the command
+#' @param path the directory to run the command in.
+#' @param env_vars environment variables to set before running the command.
+#' @param ... additional arguments passed to \code{\link{system_check}}
+#' @return \code{TRUE} if the command succeeds, throws an error if the command
+#' fails.
+#' @export
 RCMD <- function(cmd, options, path = tempdir(), env_vars = NULL, ...) {
   options <- paste(options, collapse = " ")
   R(paste("CMD", cmd, options), path = path, env_vars = env_vars, ...)
@@ -21,7 +31,7 @@ RCMD <- function(cmd, options, path = tempdir(), env_vars = NULL, ...) {
 #'
 #' Devtools sets a number of environmental variables to ensure consistent
 #' between the current R session and the new session, and to ensure that
-#' everying behaves the same across systems. It also suppresses a common
+#' everything behaves the same across systems. It also suppresses a common
 #' warning on windows, and sets \code{NOT_CRAN} so you can tell that your
 #' code is not running on CRAN.
 #'
@@ -32,9 +42,9 @@ r_env_vars <- function() {
   c("R_LIBS" = paste(.libPaths(), collapse = .Platform$path.sep),
     "CYGWIN" = "nodosfilewarning",
     # When R CMD check runs tests, it sets R_TESTS. When the tests
-    # themeselves run R CMD xxxx, as is the case with the tests in
+    # themselves run R CMD xxxx, as is the case with the tests in
     # devtools, having R_TESTS set causes errors because it confuses
-    # the R subprocesses. Unsetting it here avoids those problems.
+    # the R subprocesses. Un-setting it here avoids those problems.
     "R_TESTS" = "",
     "NOT_CRAN" = "true",
     "TAR" = auto_tar())
@@ -52,4 +62,3 @@ auto_tar <- function() {
   no_rtools <- is.null(get_rtools_path())
   if (windows && no_rtools) "internal" else ""
 }
-

R/system.r

@@ -1,5 +1,13 @@
-# @param arg a vector of command arguments.
-# @param env a named character vector of environment variables.  Will be quoted
+#' Run a system command and check if it succeeds.
+#'
+#' @param cmd the command to run.
+#' @param args a vector of command arguments.
+#' @param env a named character vector of environment variables.  Will be quoted
+#' @param quiet if \code{FALSE}, the command to be run will be echoed.
+#' @param ... additional arguments passed to \code{\link[base]{system}}
+#' @return \code{TRUE} if the command succeeds, an error will be thrown if the
+#' command fails.
+#' @export
 system_check <- function(cmd, args = character(), env = character(),
                          quiet = FALSE, ...) {
   full <- paste(shQuote(cmd), " ", paste(args, collapse = ", "), sep = "")
@@ -32,4 +40,3 @@ wrap_command <- function(x) {
   continue <- c(rep(" \\", length(lines) - 1), "")
   paste(lines, continue, collapse = "\n")
 }
-

man/RCMD.Rd

@@ -0,0 +1,27 @@
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/R.r
+\name{RCMD}
+\alias{RCMD}
+\title{Run R CMD xxx from within R}
+\usage{
+RCMD(cmd, options, path = tempdir(), env_vars = NULL, ...)
+}
+\arguments{
+\item{cmd}{one of the R tools available from the R CMD interface.}
+
+\item{options}{a charater vector of options to pass to the command}
+
+\item{path}{the directory to run the command in.}
+
+\item{env_vars}{environment variables to set before running the command.}
+
+\item{...}{additional arguments passed to \code{\link{system_check}}}
+}
+\value{
+\code{TRUE} if the command succeeds, throws an error if the command
+fails.
+}
+\description{
+Run R CMD xxx from within R
+}
+

man/r_env_vars.Rd

@@ -12,7 +12,7 @@ a named character vector
 \description{
 Devtools sets a number of environmental variables to ensure consistent
 between the current R session and the new session, and to ensure that
-everying behaves the same across systems. It also suppresses a common
+everything behaves the same across systems. It also suppresses a common
 warning on windows, and sets \code{NOT_CRAN} so you can tell that your
 code is not running on CRAN.
 }

man/system_check.Rd

@@ -0,0 +1,28 @@
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/system.r
+\name{system_check}
+\alias{system_check}
+\title{Run a system command and check if it succeeds.}
+\usage{
+system_check(cmd, args = character(), env = character(), quiet = FALSE,
+  ...)
+}
+\arguments{
+\item{cmd}{the command to run.}
+
+\item{args}{a vector of command arguments.}
+
+\item{env}{a named character vector of environment variables.  Will be quoted}
+
+\item{quiet}{if \code{FALSE}, the command to be run will be echoed.}
+
+\item{...}{additional arguments passed to \code{\link[base]{system}}}
+}
+\value{
+\code{TRUE} if the command succeeds, an error will be thrown if the
+command fails.
+}
+\description{
+Run a system command and check if it succeeds.
+}
+