prepare deprecating pander.return and pander.option

Author: daroczig

NAMESPACE

@@ -74,6 +74,7 @@ export(pander)
 export(pander.option)
 export(pander.return)
 export(panderOptions)
+export(pander_return)
 export(pandoc.date)
 export(pandoc.date.return)
 export(pandoc.emphasis)

R/S3.R

@@ -106,14 +106,26 @@ pander <- function(x = NULL, ...) {
 }
 
 
-#' Pander and capture output
+#' Deprecated pander_return
 #'
 #' This is a wrapper function around \code{pander} but instead of printing to \code{stdout}, this function returns a character vector of the captured lines.
 #' @param ... everything passed to \code{pander}
 #' @export pander.return
 #' @usage pander.return(...)
 #' @seealso pander
-pander.return <- function(...)
+pander.return <- function(...) {
+    .Deprecated('pander_return')
+    capture.output(pander(...))
+}
+
+
+#' Pander and capture output
+#'
+#' This is a wrapper function around \code{pander} but instead of printing to \code{stdout}, this function returns a character vector of the captured lines.
+#' @param ... everything passed to \code{pander}
+#' @export
+#' @seealso pander
+pander_return <- function(...)
     capture.output(pander(...))
 
 
@@ -1543,9 +1555,9 @@ pander.function <- function(x, add.name = FALSE, verbatim = TRUE, syntax.highlig
 #'    s[even] <- sprintf("(%s)", s[even])
 #'    s
 #' }
-#' tab <- tabular( Justify(c)*Heading()*z*Sex*Heading(Statistic)*Format(fmt())*(mean+sd) 
+#' tab <- tabular( Justify(c)*Heading()*z*Sex*Heading(Statistic)*Format(fmt())*(mean+sd)
 #'                ~ Status )
-#' pander(tab, emphasize.rownames = FALSE)               
+#' pander(tab, emphasize.rownames = FALSE)
 pander.tabular <- function(x, caption = attr(x, 'caption'), emphasize.rownames = TRUE, digits = panderOptions('digits'), ...) {
     if (is.null(caption) & !is.null(storage$caption))
         caption <- get.caption()
@@ -1557,17 +1569,16 @@ pander.tabular <- function(x, caption = attr(x, 'caption'), emphasize.rownames =
     if (!is.null(colnames(rlabels))) { # needed for case of more complex tabular structure (see examples)
         cl <- colnames(rlabels)
         data <- cbind(rlabels, data)
-        clabels <- cbind(rbind(matrix("", 
-                                      nrow = (nrow(clabels) - 1), 
+        clabels <- cbind(rbind(matrix("",
+                                      nrow = (nrow(clabels) - 1),
                                       ncol = length(cl)),
-                               colnames(rlabels)), 
+                               colnames(rlabels)),
                          clabels)
-    } 
+    }
     clabels <- apply(clabels, c(2), paste, collapse = "\\ \n")
     colnames(data) <- clabels
     if (emphasize.rownames)
         pandoc.table(data, caption = caption, keep.line.breaks = TRUE, emphasize.cols = 1:length(cl), ...)
     else
         pandoc.table(data, caption = caption, keep.line.breaks = TRUE, ...)
 }
-

R/options.R

@@ -295,6 +295,7 @@ panderOptions <- function(o, value) {
 #' @export pander.option
 #' @seealso panderOptions
 pander.option <- function(x, ...) {
+    .Deprecated('panderOptions')
     mc <- match.call(panderOptions)
     mc[[1]] <- quote(panderOptions)
     eval(mc)

man/pander.return.Rd

@@ -2,7 +2,7 @@
 % Please edit documentation in R/S3.R
 \name{pander.return}
 \alias{pander.return}
-\title{Pander and capture output}
+\title{Deprecated pander_return}
 \usage{
 pander.return(...)
 }

man/pander_return.Rd

@@ -0,0 +1,18 @@
+% Generated by roxygen2 (4.1.1): do not edit by hand
+% Please edit documentation in R/S3.R
+\name{pander_return}
+\alias{pander_return}
+\title{Pander and capture output}
+\usage{
+pander_return(...)
+}
+\arguments{
+\item{...}{everything passed to \code{pander}}
+}
+\description{
+This is a wrapper function around \code{pander} but instead of printing to \code{stdout}, this function returns a character vector of the captured lines.
+}
+\seealso{
+pander
+}
+