diff --git a/NEWS.md b/NEWS.md index 35358a6..d459572 100644 --- a/NEWS.md +++ b/NEWS.md @@ -54,7 +54,7 @@ * `theme_kable` (PDF) pass options to kable * `theme_caption` (HTML, PDF) Set a caption. * `condformat2grob`: Engine to render tables as graphics -* Shiny: renderCondformat works with async promises (if htmlwidgets 1.3 is available) +* Shiny: `renderCondformat` works with "async" promises (if htmlwidgets 1.3 is available) ## Deprecations: @@ -90,7 +90,7 @@ # condformat 0.6.0 * Fix tibble formatting issues, causing package malfunction. -* Bugfix: `theme_htmlTable()` now accepts the `css.cell` argument (thanks +* Fix: `theme_htmlTable()` now accepts the `css.cell` argument (thanks to 鱼飞灰 for reporting it) * Require latest `htmlTable`. Improve/fix printing of condformat @@ -103,7 +103,7 @@ * PDF support: Fix extra `NULL` when printing. Closes #4. * Demote xlsx (and rJava) to Suggests. * Fix standard evaluation functions, they now use formulas. See the examples (Reported in #5). -* Fix Excel export (fixed in 80440ecfd16fb74e3e0aa4c6ebc623ad2ae74b15, reported in #7) +* Fix Excel export (fixed in `80440ecfd16fb74e3e0aa4c6ebc623ad2ae74b15`, reported in #7) # condformat 0.4.0 diff --git a/R/condformat.R b/R/condformat.R index 2d66379..fc355ae 100644 --- a/R/condformat.R +++ b/R/condformat.R @@ -6,12 +6,12 @@ #' #' @param x A matrix or data.frame #' -#' @return The condformat_tbl object. This object can be piped to apply +#' @return The `condformat_tbl` object. This object can be piped to apply #' conditional formatting rules. It can also be used as a conventional #' data frame. #' -#' The condformat_tbl print method generates an htmlTable, to be -#' viewed using RStudio Viewer or an HTML browser, as available. +#' The `condformat_tbl` print method generates an `htmlTable`, to be +#' viewed using the 'RStudio Viewer' or an 'HTML browser', as available. #' @examples #' data(iris) #' cf <- condformat(iris[1:5,]) diff --git a/R/condformat_render.R b/R/condformat_render.R index b2fcde7..4fc7aba 100644 --- a/R/condformat_render.R +++ b/R/condformat_render.R @@ -1,9 +1,9 @@ -#' Prints the data frame in an html page and shows it. +#' Prints the data frame in an HTML page and shows it. #' -#' @param x A condformat_tbl object +#' @param x A `condformat_tbl` object #' @inheritDotParams htmltools::html_print -html -#' @param paginate A logical value. If TRUE the printing will be paginated -#' @return the value returned by htmlTable +#' @param paginate A logical value. If `TRUE` the printing will be paginated +#' @return the value returned by [htmlTable::htmlTable()] #' @examples #' data(iris) #' \dontrun{ @@ -29,7 +29,7 @@ condformat2html_or_widget <- function(x, paginate = TRUE) { #' Print method for knitr, exporting to HTML or LaTeX as needed #' @param x Object to print -#' @param ... On a LaTeX output these are unused. On an HTML output can have "paginate=TRUE" or "paginate = FALSE" +#' @param ... On a LaTeX output these are unused. On an HTML output can have `paginate=TRUE` or `paginate = FALSE` #' @importFrom knitr knit_print #' @export knit_print.condformat_tbl <- function(x, ...) { @@ -95,7 +95,7 @@ render_show_condformat_tbl <- function(x) { return(finalshow) } -# Renders the css matrix to format the xview table +# Renders the css matrix to format the `xview` table # # @param rules List of rules to be applied # @param xview Data frame with the rows and columns that will be printed diff --git a/man/condformat.Rd b/man/condformat.Rd index 677051f..b55146b 100644 --- a/man/condformat.Rd +++ b/man/condformat.Rd @@ -10,12 +10,12 @@ condformat(x) \item{x}{A matrix or data.frame} } \value{ -The condformat_tbl object. This object can be piped to apply +The \code{condformat_tbl} object. This object can be piped to apply conditional formatting rules. It can also be used as a conventional data frame. -The condformat_tbl print method generates an htmlTable, to be -viewed using RStudio Viewer or an HTML browser, as available. +The \code{condformat_tbl} print method generates an \code{htmlTable}, to be +viewed using the 'RStudio Viewer' or an 'HTML browser', as available. } \description{ A \code{condformat_tbl} object is a data frame with attributes regarding diff --git a/man/knit_print.condformat_tbl.Rd b/man/knit_print.condformat_tbl.Rd index 066d39d..8bdc850 100644 --- a/man/knit_print.condformat_tbl.Rd +++ b/man/knit_print.condformat_tbl.Rd @@ -9,7 +9,7 @@ \arguments{ \item{x}{Object to print} -\item{...}{On a LaTeX output these are unused. On an HTML output can have "paginate=TRUE" or "paginate = FALSE"} +\item{...}{On a LaTeX output these are unused. On an HTML output can have \code{paginate=TRUE} or \code{paginate = FALSE}} } \description{ Print method for knitr, exporting to HTML or LaTeX as needed diff --git a/man/print.condformat_tbl.Rd b/man/print.condformat_tbl.Rd index 7c9f9c8..c2e9387 100644 --- a/man/print.condformat_tbl.Rd +++ b/man/print.condformat_tbl.Rd @@ -2,12 +2,12 @@ % Please edit documentation in R/condformat_render.R \name{print.condformat_tbl} \alias{print.condformat_tbl} -\title{Prints the data frame in an html page and shows it.} +\title{Prints the data frame in an HTML page and shows it.} \usage{ \method{print}{condformat_tbl}(x, ..., paginate = TRUE) } \arguments{ -\item{x}{A condformat_tbl object} +\item{x}{A \code{condformat_tbl} object} \item{...}{ Arguments passed on to \code{\link[htmltools:html_print]{htmltools::html_print}} @@ -17,13 +17,13 @@ HTML page. Can be \code{NULL}, in which case no viewer will be invoked.} }} -\item{paginate}{A logical value. If TRUE the printing will be paginated} +\item{paginate}{A logical value. If \code{TRUE} the printing will be paginated} } \value{ -the value returned by htmlTable +the value returned by \code{\link[htmlTable:htmlTable]{htmlTable::htmlTable()}} } \description{ -Prints the data frame in an html page and shows it. +Prints the data frame in an HTML page and shows it. } \examples{ data(iris)