Removed calls to pander.return + roxygenize

NAMESPACE

@@ -1,4 +1,4 @@
-# Generated by roxygen2 (4.1.1): do not edit by hand
+# Generated by roxygen2 (4.1.0): do not edit by hand
 
 S3method(pander,"NULL")
 S3method(pander,"function")

R/S3.R

@@ -106,7 +106,7 @@ pander <- function(x = NULL, ...) {
 }
 
 
-#' Deprecated pander_return
+#' 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}
@@ -1185,7 +1185,7 @@ pander.describe <- function(x, caption = attr(x, 'caption'), short = TRUE, split
                             z <- w
                         else z <- paste(z, w, sep = ', ')
                     }
-                    val <- pander.return(z)
+                    val <- pander_return(z)
                 } else {
                     dim.val <- dim(val)
                     if (is.null(dim.val)) {
@@ -1450,9 +1450,9 @@ pander.sessionInfo <- function (x, locale = TRUE, compact = TRUE, ...) {
     }
 
     if (compact) {
-        attached.base.packages <- pander.return(x$basePkgs, quote = FALSE, ...)
-        other.attached.packages <- pander.return(mkLabel(x, 'otherPkgs'), quote = FALSE, ...)
-        load.via.namespaces <- pander.return(mkLabel(x, 'loadedOnly'), quote = FALSE, ...)
+        attached.base.packages <- pander_return(x$basePkgs, quote = FALSE, ...)
+        other.attached.packages <- pander_return(mkLabel(x, 'otherPkgs'), quote = FALSE, ...)
+        load.via.namespaces <- pander_return(mkLabel(x, 'loadedOnly'), quote = FALSE, ...)
     } else {
         attached.base.packages <- pandoc.list.return(x$basePkgs, add.end.of.list = FALSE, ...)
         other.attached.packages <- pandoc.list.return(mkLabel(x, 'otherPkgs'), add.end.of.list = FALSE, ...)

R/brew.R

@@ -104,7 +104,7 @@ Pandoc.brew <- function(file = stdin(), output = stdout(), convert = FALSE, open
         ## format 'em
         for (r in res) {
 
-            r.pander <- tryCatch(pander.return(r), error = function(e) e)
+            r.pander <- tryCatch(pander_return(r), error = function(e) e)
             if (inherits(r.pander, 'error'))
                 r.pander <- paste0('Internal `pander` error: `', r.pander$message, '` while running: `', r$src,'`\n\nPlease [report the issue](https://github.com/Rapporter/pander/issues/new) with a reproducible example to help developers fix this ASAP.')
             r$output <- r.pander

R/evals.R

@@ -553,10 +553,10 @@ eval.msgs <- function(src, env = NULL, showInvisible = FALSE, graph.unify = eval
 #'
 #' ## hooks
 #' txt <- 'runif(1:4); matrix(runif(25), 5, 5); 1:5'
-#' hooks <- list('numeric' = round, 'matrix' = pander.return)
+#' hooks <- list('numeric' = round, 'matrix' = pander_return)
 #' evals(txt, hooks = hooks)
 #' ## using pander's default hook
-#' evals(txt, hooks = list('default' = pander.return))
+#' evals(txt, hooks = list('default' = pander_return))
 #' evals('22/7', hooks = list('numeric' = round))
 #' evals('matrix(runif(25), 5, 5)', hooks = list('matrix' = round))
 #'
@@ -589,7 +589,7 @@ eval.msgs <- function(src, env = NULL, showInvisible = FALSE, graph.unify = eval
 #'
 #' # hooks & filtering
 #' evals('matrix(5,5,5)',
-#'   hooks = list('matrix' = pander.return),
+#'   hooks = list('matrix' = pander_return),
 #'   output = 'result')
 #'
 #' # eval-ing chunks in given environment

R/options.R

@@ -316,7 +316,7 @@ pander.option <- function(x, ...) {
 #'      \item \code{cache.time}: number of seconds to limit caching based on \code{proc.time}. If set to \code{0}, all R commands, if set to \code{Inf}, none is cached (despite the \code{cache} parameter).
 #'      \item \code{cache.copy.images}: copy images to new files if an image is returned from cache? If set to \code{FALSE} (default) the "old" path would be returned.
 #'      \item \code{classes}: a vector or list of classes which should be returned. If set to \code{NULL} (by default) all R objects will be returned.
-#'      \item \code{hooks}: list of hooks to be run for given classes in the form of \code{list(class = fn)}. If you would also specify some parameters of the function, a list should be provided in the form of \code{list(fn, param1, param2=NULL)} etc. So the hooks would become \code{list(class1=list(fn, param1, param2=NULL), ...)}. See examples of \code{\link{evals}}. A default hook can be specified too by setting the class to \code{'default'}. This can be handy if you do not want to define separate methods/functions to each possible class, but automatically apply the default hook to all classes not mentioned in the list. You may also specify only one element in the list like: \code{hooks=list('default' = pander.return)}. Please note, that nor error/warning messages, nor stdout is captured (so: updated) while running hooks!
+#'      \item \code{hooks}: list of hooks to be run for given classes in the form of \code{list(class = fn)}. If you would also specify some parameters of the function, a list should be provided in the form of \code{list(fn, param1, param2=NULL)} etc. So the hooks would become \code{list(class1=list(fn, param1, param2=NULL), ...)}. See examples of \code{\link{evals}}. A default hook can be specified too by setting the class to \code{'default'}. This can be handy if you do not want to define separate methods/functions to each possible class, but automatically apply the default hook to all classes not mentioned in the list. You may also specify only one element in the list like: \code{hooks=list('default' = pander_return)}. Please note, that nor error/warning messages, nor stdout is captured (so: updated) while running hooks!
 #'      \item \code{length}: any R object exceeding the specified length will not be returned. The default value (\code{Inf}) does not filter out any R objects.
 #'      \item \code{output}: a character vector of required returned values. This might be useful if you are only interested in the \code{result}, and do not want to save/see e.g. \code{messages} or \code{print}ed \code{output}. See examples of \code{\link{evals}}.
 #'      \item \code{graph.unify}: should \code{evals} try to unify the style of (\code{base}, \code{lattice} and \code{ggplot2}) plots? If set to \code{TRUE}, some \code{panderOptions()} would apply. By default this is disabled not to freak out useRs :)

inst/tests/test-missing.R

@@ -7,16 +7,16 @@ pom <- panderOptions('missing')
 
 panderOptions('missing', '<missing>')
 test_that('replacing missing values works with string', {
-    expect_equal(pander.return(c(1, NA)), "_1_ and _<missing>_")
-    expect_equal(paste(pander.return(list(1, NA)), collapse = '\n'), "\n\n  * _1_\n  * <missing>\n\n<!-- end of list -->\n\n")
-    expect_equal(paste(pander.return(data.frame(a=1:2, b=c(1, NA), c=c(NA, 'z'))), collapse = '\n'), "\n-----------------------\n a      b         c    \n--- --------- ---------\n 1      1     <missing>\n\n 2  <missing>     z    \n-----------------------\n")
+    expect_equal(pander_return(c(1, NA)), "_1_ and _<missing>_")
+    expect_equal(paste(pander_return(list(1, NA)), collapse = '\n'), "\n\n  * _1_\n  * <missing>\n\n<!-- end of list -->\n\n")
+    expect_equal(paste(pander_return(data.frame(a=1:2, b=c(1, NA), c=c(NA, 'z'))), collapse = '\n'), "\n-----------------------\n a      b         c    \n--- --------- ---------\n 1      1     <missing>\n\n 2  <missing>     z    \n-----------------------\n")
 })
 
 panderOptions('missing', '')
 test_that('suppressing missing values works', {
-    expect_equal(pander.return(c(1, NA)), "_1_ and __")
-    expect_equal(paste(pander.return(list(1, NA)), collapse = '\n'), "\n\n  * _1_\n  *\n\n<!-- end of list -->\n\n")
-    expect_equal(paste(pander.return(data.frame(a=1:2, b=c(1, NA), c=c(NA, 'z'))), collapse = '\n'), "\n-----------\n a   b   c \n--- --- ---\n 1   1     \n\n 2       z \n-----------\n")
+    expect_equal(pander_return(c(1, NA)), "_1_ and __")
+    expect_equal(paste(pander_return(list(1, NA)), collapse = '\n'), "\n\n  * _1_\n  *\n\n<!-- end of list -->\n\n")
+    expect_equal(paste(pander_return(data.frame(a=1:2, b=c(1, NA), c=c(NA, 'z'))), collapse = '\n'), "\n-----------\n a   b   c \n--- --- ---\n 1   1     \n\n 2       z \n-----------\n")
 })
 
 panderOptions('missing', pom)

man/Pandoc-class.Rd

@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/R5.R
 \docType{class}
 \name{Pandoc-class}

man/Pandoc.brew.Rd

@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/brew.R
 \name{Pandoc.brew}
 \alias{Pandoc.brew}

man/Pandoc.convert.Rd

@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/convert.R
 \name{Pandoc.convert}
 \alias{Pandoc.convert}

man/add.blank.lines.Rd

@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/helpers.R
 \name{add.blank.lines}
 \alias{add.blank.lines}

man/add.lattice.grid.Rd

@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/graph.R
 \name{add.lattice.grid}
 \alias{add.lattice.grid}

man/add.lattice.xsubticks.Rd

@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/graph.R
 \name{add.lattice.xsubticks}
 \alias{add.lattice.xsubticks}

man/add.minor.ticks.Rd

@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/graph.R
 \name{add.minor.ticks}
 \alias{add.minor.ticks}

man/add.significance.stars.Rd

@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/helpers.R
 \name{add.significance.stars}
 \alias{add.significance.stars}

man/brew.Rd

@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/brew.R
 \name{brew}
 \alias{brew}

man/cache.off.Rd

@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/helpers.R
 \name{cache.off}
 \alias{cache.off}

man/check_caption.Rd

@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/helpers.R
 \name{check_caption}
 \alias{check_caption}

man/emphasize.rows.Rd

@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/helpers.R
 \name{emphasize.rows}
 \alias{emphasize.cells}

man/eval.msgs.Rd

@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/evals.R
 \name{eval.msgs}
 \alias{eval.msgs}

man/evals.Rd

@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/evals.R
 \name{evals}
 \alias{evals}
@@ -247,10 +247,10 @@ evals(txt, classes = c('numeric', 'list'))
 
 ## hooks
 txt <- 'runif(1:4); matrix(runif(25), 5, 5); 1:5'
-hooks <- list('numeric' = round, 'matrix' = pander.return)
+hooks <- list('numeric' = round, 'matrix' = pander_return)
 evals(txt, hooks = hooks)
 ## using pander's default hook
-evals(txt, hooks = list('default' = pander.return))
+evals(txt, hooks = list('default' = pander_return))
 evals('22/7', hooks = list('numeric' = round))
 evals('matrix(runif(25), 5, 5)', hooks = list('matrix' = round))
 
@@ -283,7 +283,7 @@ evals('matrix(1,1,1)', length = 1, classes = 'numeric')
 
 # hooks & filtering
 evals('matrix(5,5,5)',
-  hooks = list('matrix' = pander.return),
+  hooks = list('matrix' = pander_return),
   output = 'result')
 
 # eval-ing chunks in given environment

man/evalsOptions.Rd

@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/options.R
 \name{evalsOptions}
 \alias{evals.option}
@@ -26,7 +26,7 @@ The following \code{evals} options are available:
      \item \code{cache.time}: number of seconds to limit caching based on \code{proc.time}. If set to \code{0}, all R commands, if set to \code{Inf}, none is cached (despite the \code{cache} parameter).
      \item \code{cache.copy.images}: copy images to new files if an image is returned from cache? If set to \code{FALSE} (default) the "old" path would be returned.
      \item \code{classes}: a vector or list of classes which should be returned. If set to \code{NULL} (by default) all R objects will be returned.
-     \item \code{hooks}: list of hooks to be run for given classes in the form of \code{list(class = fn)}. If you would also specify some parameters of the function, a list should be provided in the form of \code{list(fn, param1, param2=NULL)} etc. So the hooks would become \code{list(class1=list(fn, param1, param2=NULL), ...)}. See examples of \code{\link{evals}}. A default hook can be specified too by setting the class to \code{'default'}. This can be handy if you do not want to define separate methods/functions to each possible class, but automatically apply the default hook to all classes not mentioned in the list. You may also specify only one element in the list like: \code{hooks=list('default' = pander.return)}. Please note, that nor error/warning messages, nor stdout is captured (so: updated) while running hooks!
+     \item \code{hooks}: list of hooks to be run for given classes in the form of \code{list(class = fn)}. If you would also specify some parameters of the function, a list should be provided in the form of \code{list(fn, param1, param2=NULL)} etc. So the hooks would become \code{list(class1=list(fn, param1, param2=NULL), ...)}. See examples of \code{\link{evals}}. A default hook can be specified too by setting the class to \code{'default'}. This can be handy if you do not want to define separate methods/functions to each possible class, but automatically apply the default hook to all classes not mentioned in the list. You may also specify only one element in the list like: \code{hooks=list('default' = pander_return)}. Please note, that nor error/warning messages, nor stdout is captured (so: updated) while running hooks!
      \item \code{length}: any R object exceeding the specified length will not be returned. The default value (\code{Inf}) does not filter out any R objects.
      \item \code{output}: a character vector of required returned values. This might be useful if you are only interested in the \code{result}, and do not want to save/see e.g. \code{messages} or \code{print}ed \code{output}. See examples of \code{\link{evals}}.
      \item \code{graph.unify}: should \code{evals} try to unify the style of (\code{base}, \code{lattice} and \code{ggplot2}) plots? If set to \code{TRUE}, some \code{panderOptions()} would apply. By default this is disabled not to freak out useRs :)

man/get.alignment.Rd

@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/helpers.R
 \name{get.alignment}
 \alias{get.alignment}

man/get.caption.Rd

@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/helpers.R
 \name{get.caption}
 \alias{get.caption}

man/get.emphasize.Rd

@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/helpers.R
 \name{get.emphasize}
 \alias{get.emphasize}

man/get.storage.Rd

@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/helpers.R
 \name{get.storage}
 \alias{get.storage}

man/has.rownames.Rd

@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/helpers.R
 \name{has.rownames}
 \alias{has.rownames}

man/openFileInOS.Rd

@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/convert.R
 \name{openFileInOS}
 \alias{openFileInOS}

man/p.Rd

@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/helpers.R
 \name{p}
 \alias{p}

man/pander.CrossTable.Rd

@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/S3.R
 \name{pander.CrossTable}
 \alias{pander.CrossTable}

man/pander.Date.Rd

@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/S3.R
 \name{pander.Date}
 \alias{pander.Date}

man/pander.NULL.Rd

@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/S3.R
 \name{pander.NULL}
 \alias{pander.NULL}

man/pander.POSIXct.Rd

@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/S3.R
 \name{pander.POSIXct}
 \alias{pander.POSIXct}

man/pander.POSIXlt.Rd

@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/S3.R
 \name{pander.POSIXlt}
 \alias{pander.POSIXlt}

man/pander.Rd

@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/S3.R
 \name{pander}
 \alias{pander}

man/pander.anova.Rd

@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/S3.R
 \name{pander.anova}
 \alias{pander.anova}

man/pander.aov.Rd

@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/S3.R
 \name{pander.aov}
 \alias{pander.aov}

man/pander.aovlist.Rd

@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/S3.R
 \name{pander.aovlist}
 \alias{pander.aovlist}

man/pander.call.Rd

@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/S3.R
 \name{pander.call}
 \alias{pander.call}

man/pander.cast_df.Rd

@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/S3.R
 \name{pander.cast_df}
 \alias{pander.cast_df}

man/pander.character.Rd

@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/S3.R
 \name{pander.character}
 \alias{pander.character}

man/pander.clogit.Rd

@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/S3.R
 \name{pander.clogit}
 \alias{pander.clogit}

man/pander.coxph.Rd

@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/S3.R
 \name{pander.coxph}
 \alias{pander.coxph}

man/pander.data.frame.Rd

@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/S3.R
 \name{pander.data.frame}
 \alias{pander.data.frame}

man/pander.default.Rd

@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/S3.R
 \name{pander.default}
 \alias{pander.default}

man/pander.density.Rd

@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/S3.R
 \name{pander.density}
 \alias{pander.density}

man/pander.describe.Rd

@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.1): do not edit by hand
+% Generated by roxygen2 (4.1.0): do not edit by hand
 % Please edit documentation in R/S3.R
 \name{pander.describe}
 \alias{pander.describe}