Skip to content

Commit

Permalink
Minor doc improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
zeehio committed Oct 8, 2023
1 parent 693c075 commit 3418432
Show file tree
Hide file tree
Showing 6 changed files with 21 additions and 21 deletions.
6 changes: 3 additions & 3 deletions NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -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

Expand All @@ -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

Expand Down
6 changes: 3 additions & 3 deletions R/condformat.R
Original file line number Diff line number Diff line change
Expand Up @@ -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,])
Expand Down
12 changes: 6 additions & 6 deletions R/condformat_render.R
Original file line number Diff line number Diff line change
@@ -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{
Expand All @@ -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, ...) {
Expand Down Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions man/condformat.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/knit_print.condformat_tbl.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 5 additions & 5 deletions man/print.condformat_tbl.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 3418432

Please sign in to comment.