Examples and tests don't open browser windows anymore

zeehio · May 14, 2020 · 6cb3380 · 6cb3380
1 parent 8d4ba0a
commit 6cb3380
Show file tree

Hide file tree

Showing 37 changed files with 240 additions and 59 deletions.
diff --git a/NEWS.md b/NEWS.md
@@ -20,6 +20,7 @@
 * Replace xlsx with openxlsx. This avoids pulling RJava as a suggested dependency
 * Warn if unsupported rule is used with Excel output
 * Fix warning due to rlang update
+* Change examples and tests so they don't open browser windows
 
 # condformat 0.8.0
 

diff --git a/R/condformat.R b/R/condformat.R
@@ -14,12 +14,21 @@
 #'  viewed using RStudio Viewer or an HTML browser, as available.
 #' @examples
 #' data(iris)
-#' condformat(iris[1:5,])
+#' cf <- condformat(iris[1:5,])
+#' \dontrun{
+#' print(cf)
+#' }
 #'
-#' condformat(iris[1:5,]) %>% rule_fill_gradient(Sepal.Length)
+#' cf <- condformat(iris[1:5,]) %>% rule_fill_gradient(Sepal.Length)
+#' \dontrun{
+#' print(cf)
+#' }
 #'
-#' condformat(iris[1:5,]) %>%
+#' cf <- condformat(iris[1:5,]) %>%
 #'  rule_fill_discrete(Sepal.Length, expression=Sepal.Width > 2)
+#' \dontrun{
+#' print(cf)
+#' }
 #' @export
 condformat <- function(x) {
   x <- tibble::as_tibble(x)

diff --git a/R/condformat_render.R b/R/condformat_render.R
@@ -6,7 +6,9 @@
 #' @return the value returned by htmlTable
 #' @examples
 #' data(iris)
+#' \dontrun{
 #' print(condformat(iris[1:5,]))
+#' }
 #' @export
 print.condformat_tbl <- function(x, ..., paginate = TRUE) {
   if (!is.null(getOption("knitr.in.progress"))) {

diff --git a/R/render_html.R b/R/render_html.R
@@ -4,7 +4,10 @@
 #' @return the htmlTable object
 #' @examples
 #' data(iris)
-#' condformat2html(condformat(iris[1:5,]))
+#' cf <- condformat2html(condformat(iris[1:5,]))
+#' \dontrun{
+#' print(cf)
+#' }
 #' @export
 condformat2html <- function(x) {
   htmltable_ready <- condformat2htmlcommon(x)
@@ -23,7 +26,10 @@ condformat2html <- function(x) {
 #' @examples
 #' \dontrun{
 #' data(iris)
-#' condformat2widget(condformat(iris[1:5,]))
+#' cf <- condformat2widget(condformat(iris[1:5,]))
+#' \dontrun{
+#' print(cf)
+#' }
 #' }
 #' @export
 condformat2widget <- function(x, ...) {

diff --git a/R/rule_css.R b/R/rule_css.R
@@ -7,9 +7,12 @@
 #' @param na.value CSS property value to be used in missing values (e.g. `"grey"`)
 #' @examples
 #' data(iris)
-#' condformat(iris[c(1:5, 51:55, 101:105),]) %>%
+#' cf <- condformat(iris[c(1:5, 51:55, 101:105),]) %>%
 #'   rule_css(Species, expression = ifelse(Species == "setosa", "red", "darkgreen"),
 #'            css_field = "color")
+#' \dontrun{
+#' print(cf)
+#' }
 #' @export
 rule_css <- function(x, columns, expression,
                      css_field,

diff --git a/R/rule_fill_bar.R b/R/rule_fill_bar.R
@@ -21,7 +21,10 @@
 #' @return The condformat_tbl object, with the added formatting information
 #' @examples
 #' data(iris)
-#' condformat(iris[c(1:5, 70:75, 120:125), ]) %>% rule_fill_bar("Sepal.Length")
+#' cf <- condformat(iris[c(1:5, 70:75, 120:125), ]) %>% rule_fill_bar("Sepal.Length")
+#' \dontrun{
+#' print(cf)
+#' }
 #' @export
 rule_fill_bar <- function(x, columns, expression,
                           low = "darkgreen",

diff --git a/R/rule_fill_discrete.R b/R/rule_fill_discrete.R
@@ -19,17 +19,23 @@
 #' @return The condformat_tbl object, with the added formatting information
 #' @examples
 #' data(iris)
-#' condformat(iris[c(1:5, 70:75, 120:125), ]) %>%
+#' cf <- condformat(iris[c(1:5, 70:75, 120:125), ]) %>%
 #'  rule_fill_discrete("Species", colours = c("setosa" = "red",
 #'                                          "versicolor" = "blue",
 #'                                          "virginica" = "green")) %>%
 #'  rule_fill_discrete("Sepal.Length", expression = Sepal.Length > 4.6,
 #'                     colours=c("TRUE"="red"))
+#' \dontrun{
+#' print(cf)
+#' }
 #'
-#' condformat(iris[c(1:5, 70:75, 120:125), ]) %>%
+#' cf <- condformat(iris[c(1:5, 70:75, 120:125), ]) %>%
 #'  rule_fill_discrete(c(starts_with("Sepal"), starts_with("Petal")),
 #'                     expression = Sepal.Length > 4.6,
 #'                     colours=c("TRUE"="red"))
+#' \dontrun{
+#' print(cf)
+#' }
 #' @export
 rule_fill_discrete <- function(x, columns, expression, colours = NA,
                                na.value = "#FFFFFF",

diff --git a/R/rule_fill_gradient.R b/R/rule_fill_gradient.R
@@ -19,13 +19,19 @@
 #' @return The condformat_tbl object, with the added formatting information
 #' @examples
 #' data(iris)
-#' condformat(iris[c(1:5, 70:75, 120:125), ]) %>%
+#' cf <- condformat(iris[c(1:5, 70:75, 120:125), ]) %>%
 #'   rule_fill_gradient(Sepal.Length) %>%
 #'   rule_fill_gradient(Species, expression=Sepal.Length - Sepal.Width)
+#' \dontrun{
+#' print(cf)
+#' }
 #'
-#' condformat(iris[c(1:5, 70:75, 120:125), ]) %>%
+#' cf <- condformat(iris[c(1:5, 70:75, 120:125), ]) %>%
 #'   rule_fill_gradient("Petal.Length") %>%
 #'   rule_fill_gradient(starts_with("Sepal"), expression=Sepal.Length - Sepal.Width)
+#' \dontrun{
+#' print(cf)
+#' }
 #'
 #' @export
 rule_fill_gradient <- function(x, columns, expression,

diff --git a/R/rule_fill_gradient2.R b/R/rule_fill_gradient2.R
@@ -20,13 +20,19 @@
 #' @return The condformat_tbl object, with the added formatting information
 #' @examples
 #' data(iris)
-#' condformat(iris[c(1:5, 70:75, 120:125), ]) %>%
+#' cf <- condformat(iris[c(1:5, 70:75, 120:125), ]) %>%
 #'  rule_fill_gradient2(Sepal.Length) %>%
 #'  rule_fill_gradient2(Species, expression=Sepal.Length - Sepal.Width)
+#' \dontrun{
+#' print(cf)
+#' }
 #'
-#' condformat(iris[c(1:5, 70:75, 120:125), ]) %>%
+#' cf <- condformat(iris[c(1:5, 70:75, 120:125), ]) %>%
 #'   rule_fill_gradient2("Petal.Length") %>%
 #'   rule_fill_gradient2(starts_with("Sepal"), expression=Sepal.Length - Sepal.Width)
+#' \dontrun{
+#' print(cf)
+#' }
 #'
 #' @importFrom scales rescale_mid
 #' @export

diff --git a/R/rule_text_bold.R b/R/rule_text_bold.R
@@ -6,8 +6,11 @@
 #' @param na.bold If `TRUE`, make missing values bold.
 #' @examples
 #' data(iris)
-#' condformat(iris[c(1:5, 51:55, 101:105),]) %>%
+#' cf <- condformat(iris[c(1:5, 51:55, 101:105),]) %>%
 #'   rule_text_bold(Species, expression = Species == "setosa")
+#' \dontrun{
+#' print(cf)
+#' }
 #' @export
 rule_text_bold <- function(x, columns, expression,
                            na.bold = FALSE,

diff --git a/R/rule_text_color.R b/R/rule_text_color.R
@@ -6,8 +6,11 @@
 #' @param na.color Color for missing values
 #' @examples
 #' data(iris)
-#' condformat(iris[c(1:5, 51:55, 101:105),]) %>%
+#' cf <- condformat(iris[c(1:5, 51:55, 101:105),]) %>%
 #'   rule_text_color(Species, expression = ifelse(Species == "setosa", "blue", ""))
+#' \dontrun{
+#' print(cf)
+#' }
 #' @export
 rule_text_color <- function(x, columns, expression,
                             na.color = "",

diff --git a/R/show_columns.R b/R/show_columns.R
@@ -16,21 +16,39 @@
 #' x <- head(iris)
 #'
 #' # Include some columns:
-#' condformat(x) %>% show_columns(c(Sepal.Length, Sepal.Width, Species))
-#' condformat(x) %>% show_columns(c("Sepal.Length", "Sepal.Width", "Species"))
+#' cf <- condformat(x) %>% show_columns(c(Sepal.Length, Sepal.Width, Species))
+#' \dontrun{
+#' print(cf)
+#' }
+#' cf <- condformat(x) %>% show_columns(c("Sepal.Length", "Sepal.Width", "Species"))
+#' \dontrun{
+#' print(cf)
+#' }
 #'
 #' # Rename columns:
-#' condformat(x) %>%
+#' cf <- condformat(x) %>%
 #'   show_columns(c(Sepal.Length, Species),
 #'                col_names = c("Length", "Spec."))
+#' \dontrun{
+#' print(cf)
+#' }
 #'
 #' # Exclude some columns:
-#' condformat(x) %>% show_columns(c(-Petal.Length, -Petal.Width))
+#' cf <- condformat(x) %>% show_columns(c(-Petal.Length, -Petal.Width))
+#' \dontrun{
+#' print(cf)
+#' }
 #'
-#' condformat(x) %>% show_columns(c(starts_with("Petal"), Species))
+#' cf <- condformat(x) %>% show_columns(c(starts_with("Petal"), Species))
+#' \dontrun{
+#' print(cf)
+#' }
 #'
 #' petal_width <- "Petal.Width"
-#' condformat(x) %>% show_columns(!! petal_width)
+#' cf <- condformat(x) %>% show_columns(!! petal_width)
+#' \dontrun{
+#' print(cf)
+#' }
 #'
 #' @export
 #' @seealso \code{\link[dplyr]{select}}

diff --git a/R/show_rows.R b/R/show_rows.R
@@ -12,15 +12,24 @@
 #' library(condformat)
 #' data(iris)
 #' x <- head(iris)
-#' condformat(x) %>% show_rows(Sepal.Length > 4.5, Species == "setosa")
+#' cf <- condformat(x) %>% show_rows(Sepal.Length > 4.5, Species == "setosa")
+#' \dontrun{
+#' print(cf)
+#' }
 #' # Use it programatically
 #' expr_as_text <- 'Sepal.Length > 4.5'
 #' expr <- rlang::parse_expr(expr_as_text)
-#' condformat(x) %>% show_rows(!! expr)
+#' cf <- condformat(x) %>% show_rows(!! expr)
+#' \dontrun{
+#' print(cf)
+#' }
 #' # With multiple arguments:
 #' expr_as_text <- c('Sepal.Length > 4.5', 'Species == "setosa"')
 #' exprs <- lapply(expr_as_text, rlang::parse_expr)
-#' condformat(x) %>% show_rows(!!! exprs)
+#' cf <- condformat(x) %>% show_rows(!!! exprs)
+#' \dontrun{
+#' print(cf)
+#' }
 #' @export
 #' @seealso \code{\link[dplyr]{filter}}
 show_rows <- function(x, ...) {

diff --git a/R/theme_caption.R b/R/theme_caption.R
@@ -7,8 +7,11 @@
 #' @param caption The caption to show
 #' @examples
 #' data(iris)
-#' condformat(head(iris)) %>%
+#' cf <- condformat(head(iris)) %>%
 #'   theme_caption(caption = "My Caption")
+#' \dontrun{
+#' print(cf)
+#' }
 #' @export
 theme_caption <- function(x, caption = "") {
   if (!inherits(x, "condformat_tbl")) {

diff --git a/R/theme_grob.R b/R/theme_grob.R
@@ -7,8 +7,11 @@
 #' @seealso \code{\link[gridExtra]{tableGrob}}
 #' @examples
 #' data(iris)
-#' condformat(head(iris)) %>%
+#' cf <- condformat(head(iris)) %>%
 #'   theme_grob(base_size = 10, base_colour = "red")
+#' \dontrun{
+#' print(cf)
+#' }
 #' @export
 theme_grob <- function(x, ...) {
   if (!inherits(x, "condformat_tbl")) {

diff --git a/R/theme_htmlTable.R b/R/theme_htmlTable.R
@@ -5,7 +5,11 @@
 #' @seealso \code{\link[htmlTable]{htmlTable}}
 #' @examples
 #' data(iris)
-#' condformat(head(iris)) %>% theme_htmlTable(caption="Table 1: My iris table", rnames=FALSE)
+#' cf <- condformat(head(iris)) %>%
+#'   theme_htmlTable(caption="Table 1: My iris table", rnames=FALSE)
+#' \dontrun{
+#' print(cf)
+#' }
 #' @export
 theme_htmlTable <- function(x, ...) {
   if (!inherits(x, "condformat_tbl")) {

diff --git a/R/theme_htmlWidget.R b/R/theme_htmlWidget.R
@@ -5,9 +5,12 @@
 #' @seealso \code{\link[htmlTable]{htmlTable}}
 #' @examples
 #' data(iris)
-#' condformat(head(iris)) %>%
+#' cf <- condformat(head(iris)) %>%
 #'   theme_htmlWidget(number_of_entries = c(10, 25, 100),
 #'                    width = NULL, height = NULL, elementId = NULL)
+#' \dontrun{
+#' print(cf)
+#' }
 #' @export
 theme_htmlWidget <- function(x, ...) {
   if (!inherits(x, "condformat_tbl")) {

diff --git a/R/theme_kable.R b/R/theme_kable.R
@@ -7,8 +7,11 @@
 #' @seealso \code{\link[knitr]{kable}}
 #' @examples
 #' data(iris)
-#' condformat(head(iris)) %>%
+#' cf <- condformat(head(iris)) %>%
 #'   theme_kable(booktabs = TRUE, caption = "My Caption")
+#' \dontrun{
+#' print(cf)
+#' }
 #' @export
 theme_kable <- function(x, ...) {
   if (!inherits(x, "condformat_tbl")) {

diff --git a/man/condformat.Rd b/man/condformat.Rd
diff --git a/man/condformat2html.Rd b/man/condformat2html.Rd
diff --git a/man/condformat2widget.Rd b/man/condformat2widget.Rd
diff --git a/man/print.condformat_tbl.Rd b/man/print.condformat_tbl.Rd
diff --git a/man/rule_css.Rd b/man/rule_css.Rd