add formatter_pander resolve #22

daroczig · Oct 18, 2019 · 50db8dc · 50db8dc
1 parent 0f9d275
commit 50db8dc
Show file tree

Hide file tree

Showing 10 changed files with 47 additions and 12 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -17,6 +17,7 @@ Imports:
   utils
 Suggests:
   glue,
+  pander,
   jsonlite,
   crayon,
   slackr,

diff --git a/NAMESPACE b/NAMESPACE
@@ -23,6 +23,7 @@ export(formatter_glue)
 export(formatter_glue_or_sprintf)
 export(formatter_json)
 export(formatter_logging)
+export(formatter_pander)
 export(formatter_paste)
 export(formatter_sprintf)
 export(get_logger_meta_variables)

diff --git a/R/formatters.R b/R/formatters.R
@@ -3,7 +3,7 @@
 #' @inheritParams log_level
 #' @return character vector
 #' @export
-#' @seealso This is a \code{\link{log_formatter}}, for alternatives, see \code{\link{formatter_sprintf}}, \code{\link{formatter_glue}}, \code{\link{formatter_glue_or_sprintf}}, \code{\link{formatter_logging}}, \code{\link{formatter_json}} and \code{\link{skip_formatter}} for marking a string not to apply the formatter on it.
+#' @seealso This is a \code{\link{log_formatter}}, for alternatives, see \code{\link{formatter_sprintf}}, \code{\link{formatter_glue}}, \code{\link{formatter_glue_or_sprintf}}, \code{\link{formatter_logging}}, \code{\link{formatter_json}}, \code{\link{formatter_pander}} and \code{\link{skip_formatter}} for marking a string not to apply the formatter on it.
 formatter_paste <- structure(function(..., .logcall = sys.call(), .topcall = sys.call(-1), .topenv = parent.frame()) {
     eval(paste(...), envir = .topenv)
 }, generator = quote(formatter_paste()))
@@ -15,7 +15,7 @@ formatter_paste <- structure(function(..., .logcall = sys.call(), .topcall = sys
 #' @inheritParams log_level
 #' @return character vector
 #' @export
-#' @seealso This is a \code{\link{log_formatter}}, for alternatives, see \code{\link{formatter_paste}}, \code{\link{formatter_glue}}, \code{\link{formatter_glue_or_sprintf}}, \code{\link{formatter_logging}}, \code{\link{formatter_json}} and \code{\link{skip_formatter}} for marking a string not to apply the formatter on it.
+#' @seealso This is a \code{\link{log_formatter}}, for alternatives, see \code{\link{formatter_paste}}, \code{\link{formatter_glue}}, \code{\link{formatter_glue_or_sprintf}}, \code{\link{formatter_logging}}, \code{\link{formatter_json}}, \code{\link{formatter_pander}} and \code{\link{skip_formatter}} for marking a string not to apply the formatter on it.
 formatter_sprintf <- structure(function(fmt, ..., .logcall = sys.call(), .topcall = sys.call(-1), .topenv = parent.frame()) {
     eval(sprintf(fmt, ...), envir = .topenv)
 }, generator = quote(formatter_sprintf()))
@@ -27,7 +27,7 @@ formatter_sprintf <- structure(function(fmt, ..., .logcall = sys.call(), .topcal
 #' @return character vector
 #' @export
 #' @note Although this is the default log message formatter function, but when \pkg{glue} is not installed, \code{\link{formatter_sprintf}} will be used as a fallback.
-#' @seealso This is a \code{\link{log_formatter}}, for alternatives, see \code{\link{formatter_paste}}, \code{\link{formatter_sprintf}}, \code{\link{formatter_glue_or_sprintf}}, \code{\link{formatter_logging}}, \code{\link{formatter_json}} and \code{\link{skip_formatter}} for marking a string not to apply the formatter on it.
+#' @seealso This is a \code{\link{log_formatter}}, for alternatives, see \code{\link{formatter_paste}}, \code{\link{formatter_sprintf}}, \code{\link{formatter_glue_or_sprintf}}, \code{\link{formatter_logging}}, \code{\link{formatter_json}}, \code{\link{formatter_pander}} and \code{\link{skip_formatter}} for marking a string not to apply the formatter on it.
 #' @importFrom utils str
 formatter_glue <- structure(function(..., .logcall = sys.call(), .topcall = sys.call(-1), .topenv = parent.frame()) {
     fail_on_missing_package('glue')
@@ -67,7 +67,7 @@ formatter_glue <- structure(function(..., .logcall = sys.call(), .topcall = sys.
 #' formatter_glue_or_sprintf("Hi %s, did you know that 2*4={2*4}", c('foo', 'bar'))
 #' formatter_glue_or_sprintf("Hi %s, did you know that 2*4=%s", c('foo', 'bar'), 2*4)
 #' }
-#' @seealso This is a \code{\link{log_formatter}}, for alternatives, see \code{\link{formatter_paste}}, \code{\link{formatter_sprintf}}, \code{\link{formatter_glue_or_sprintf}}, \code{\link{formatter_logging}}, \code{\link{formatter_json}} and \code{\link{skip_formatter}} for marking a string not to apply the formatter on it.
+#' @seealso This is a \code{\link{log_formatter}}, for alternatives, see \code{\link{formatter_paste}}, \code{\link{formatter_sprintf}}, \code{\link{formatter_glue_or_sprintf}}, \code{\link{formatter_logging}}, \code{\link{formatter_json}}, \code{\link{formatter_pander}} and \code{\link{skip_formatter}} for marking a string not to apply the formatter on it.
 formatter_glue_or_sprintf <- structure(function(msg, ..., .logcall = sys.call(), .topcall = sys.call(-1), .topenv = parent.frame()) {
 
     params <- list(...)
@@ -121,7 +121,7 @@ formatter_glue_or_sprintf <- structure(function(msg, ..., .logcall = sys.call(),
 #' log_info(everything = 42)
 #' log_info(mtcars = mtcars, species = iris$Species)
 #' }
-#' @seealso This is a \code{\link{log_formatter}} potentially to be used with \code{\link{layout_json_parser}}, for alternatives, see \code{\link{formatter_paste}}, \code{\link{formatter_sprintf}}, \code{\link{formatter_glue}}, \code{\link{formatter_glue_or_sprintf}}, \code{\link{formatter_logging}} and \code{\link{skip_formatter}} for marking a string not to apply the formatter on it.
+#' @seealso This is a \code{\link{log_formatter}} potentially to be used with \code{\link{layout_json_parser}}, for alternatives, see \code{\link{formatter_paste}}, \code{\link{formatter_sprintf}}, \code{\link{formatter_glue}}, \code{\link{formatter_glue_or_sprintf}}, \code{\link{formatter_logging}}, \code{\link{formatter_pander}} and \code{\link{skip_formatter}} for marking a string not to apply the formatter on it.
 formatter_json <- structure(function(..., .logcall = sys.call(), .topcall = sys.call(-1), .topenv = parent.frame()) {
     fail_on_missing_package('jsonlite')
     eval(as.character(jsonlite::toJSON(list(...), auto_unbox = TRUE)), envir = .topenv)
@@ -160,7 +160,7 @@ skip_formatter <- function(message, ...) {
 #' @inheritParams log_level
 #' @return character vector
 #' @export
-#' @seealso This is a \code{\link{log_formatter}}, for alternatives, see \code{\link{formatter_paste}}, \code{\link{formatter_glue}}, \code{\link{formatter_glue_or_sprintf}}, \code{\link{formatter_json}} and \code{\link{skip_formatter}} for marking a string not to apply the formatter on it.
+#' @seealso This is a \code{\link{log_formatter}}, for alternatives, see \code{\link{formatter_paste}}, \code{\link{formatter_glue}}, \code{\link{formatter_glue_or_sprintf}}, \code{\link{formatter_json}}, \code{\link{formatter_pander}} and \code{\link{skip_formatter}} for marking a string not to apply the formatter on it.
 formatter_logging <- structure(function(..., .logcall = sys.call(), .topcall = sys.call(-1), .topenv = parent.frame()) {
 
     params <- list(...)
@@ -175,3 +175,28 @@ formatter_logging <- structure(function(..., .logcall = sys.call(), .topcall = s
     })
 
 }, generator = quote(formatter_logging()))
+
+
+#' Formats R objects with pander
+#' @param x object to be logged
+#' @param ... optional parameters passed to \code{pander}
+#' @inheritParams log_level
+#' @return character vector
+#' @examples \dontrun{
+#' log_formatter(formatter_pander)
+#' log_info('42')
+#' log_info(42)
+#' log_info(4+2)
+#' log_info(head(iris))
+#' log_info(head(iris), style = 'simple')
+#' log_info(lm(hp ~ wt, mtcars))
+#' }
+#' @note This functionality depends on the \pkg{pander} package.
+#' @export
+#' @seealso This is a \code{\link{log_formatter}}, for alternatives, see \code{\link{formatter_paste}}, \code{\link{formatter_sprintf}}, \code{\link{formatter_glue}}, \code{\link{formatter_glue_or_sprintf}}, \code{\link{formatter_logging}}
+formatter_pander <- structure(function(x, ..., .logcall = sys.call(), .topcall = sys.call(-1), .topenv = parent.frame()) {
+
+    fail_on_missing_package('pander')
+    eval(pander::pander_return(x, ...), envir = .topenv)
+
+}, generator = quote(formatter_pander()))
diff --git a/man/formatter_glue.Rd b/man/formatter_glue.Rd
diff --git a/man/formatter_glue_or_sprintf.Rd b/man/formatter_glue_or_sprintf.Rd
diff --git a/man/formatter_json.Rd b/man/formatter_json.Rd
diff --git a/man/formatter_logging.Rd b/man/formatter_logging.Rd
diff --git a/man/formatter_paste.Rd b/man/formatter_paste.Rd
diff --git a/man/formatter_sprintf.Rd b/man/formatter_sprintf.Rd
diff --git a/tests/testthat/test-formatters.R b/tests/testthat/test-formatters.R
@@ -101,6 +101,14 @@ test_that('special chars in the text work', {
   expect_output(log_info('JSON: {toJSON(iris[1:2, ], auto_unbox = TRUE)}'), '[{"Sepal.Length":5.1,"Sepal.Width":3.5,"Petal.Length":1.4,"Petal.Width":0.2,"Species":"setosa"},{"Sepal.Length":4.9,"Sepal.Width":3,"Petal.Length":1.4,"Petal.Width":0.2,"Species":"setosa"}]') # nolint
 })
 
+log_formatter(formatter_pander)
+test_that('pander formatter', {
+    expect_output(log_info(42), '_42_')
+    expect_output(log_info('42'), '42')
+    expect_output(log_info(head(iris)), 'Sepal.Length')
+    expect_output(log_info(lm(hp ~ wt, mtcars)), 'Fitting linear model')
+})
+
 ## cleanup
 rm(everything)
 rm(f)