Skip to content

Commit

Permalink
roxygen2md()
Browse files Browse the repository at this point in the history
  • Loading branch information
zeehio committed Oct 8, 2023
1 parent 85c6a13 commit 693c075
Show file tree
Hide file tree
Showing 17 changed files with 38 additions and 42 deletions.
4 changes: 2 additions & 2 deletions R/condformat.R
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#' Conditional formatting for data frames
#'
#' A \code{condformat_tbl} object is a data frame with attributes regarding
#' the formatting of their cells, that can be viewed when the \code{condformat_tbl}
#' A `condformat_tbl` object is a data frame with attributes regarding
#' the formatting of their cells, that can be viewed when the `condformat_tbl`
#' object is printed.
#'
#' @param x A matrix or data.frame
Expand Down
4 changes: 2 additions & 2 deletions R/shiny.R
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@
#'
#' @param outputId output variable to read from
#' @param expr An expression that generates a condformat object
#' @param env The environment in which to evaluate \code{expr}.
#' @param quoted Is \code{expr} a quoted expression (with \code{quote()})? This
#' @param env The environment in which to evaluate `expr`.
#' @param quoted Is `expr` a quoted expression (with `quote()`)? This
#' is useful if you want to save an expression in a variable.
#'
#' @param ... arguments passed to htmlOutput
Expand Down
4 changes: 2 additions & 2 deletions R/show_columns.R
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#' Selects the variables to be printed
#'
#' Keeps the variables you mention in the printed table.
#' Compared to \code{\link[dplyr]{select}}, show_columns does not remove the
#' Compared to [dplyr::select()], show_columns does not remove the
#' columns from the data frame, so formatting rules can still depend
#' on them.
#' @param x A condformat object, typically created with [condformat()]
Expand Down Expand Up @@ -51,7 +51,7 @@
#' }
#'
#' @export
#' @seealso \code{\link[dplyr]{select}}
#' @seealso [dplyr::select()]
show_columns <- function(x, columns, col_names) {
if (!inherits(x, "condformat_tbl")) {
x <- condformat(x)
Expand Down
4 changes: 2 additions & 2 deletions R/show_rows.R
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#' Selects the rows to be printed
#'
#' Keeps the rows you mention in the printed table.
#' Compared to \code{\link[dplyr]{filter}}, show_rows does not remove the
#' Compared to [dplyr::filter()], show_rows does not remove the
#' rows from the actual data frame, they are removed only for printing.
#' @param x condformat_tbl object
#' @param ... Expressions used for filtering
Expand Down Expand Up @@ -31,7 +31,7 @@
#' print(cf)
#' }
#' @export
#' @seealso \code{\link[dplyr]{filter}}
#' @seealso [dplyr::filter()]
show_rows <- function(x, ...) {
expr <- rlang::quos(...)
showobj <- structure(list(row_expr = expr),
Expand Down
2 changes: 1 addition & 1 deletion R/theme_grob.R
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
#'
#' @param x The condformat object
#' @param ... Arguments to be passed to gridExtra::tableGrob (see examples)
#' @seealso \code{\link[gridExtra]{tableGrob}}
#' @seealso [gridExtra::tableGrob()]
#' @examples
#' data(iris)
#' cf <- condformat(head(iris)) %>%
Expand Down
2 changes: 1 addition & 1 deletion R/theme_htmlTable.R
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
#'
#' @param x The condformat object
#' @param ... Arguments to be passed to htmlTable
#' @seealso \code{\link[htmlTable]{htmlTable}}
#' @seealso [htmlTable::htmlTable()]
#' @examples
#' data(iris)
#' cf <- condformat(head(iris)) %>%
Expand Down
2 changes: 1 addition & 1 deletion R/theme_htmlWidget.R
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
#'
#' @param x The condformat object
#' @param ... Arguments to be passed to htmlTable::htmlTableWidget (see examples)
#' @seealso \code{\link[htmlTable]{htmlTable}}
#' @seealso [htmlTable::htmlTable()]
#' @examples
#' data(iris)
#' cf <- condformat(head(iris)) %>%
Expand Down
2 changes: 1 addition & 1 deletion R/theme_kable.R
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
#'
#' @param x The condformat object
#' @param ... Arguments to be passed to knitr::kable (see examples)
#' @seealso \code{\link[knitr]{kable}}
#' @seealso [knitr::kable()]
#' @examples
#' data(iris)
#' cf <- condformat(head(iris)) %>%
Expand Down
12 changes: 2 additions & 10 deletions R/utils-pipe.R
Original file line number Diff line number Diff line change
@@ -1,11 +1,3 @@
#' Pipe operator
#'
#' See \code{magrittr::\link[magrittr:pipe]{\%>\%}} for details.
#'
#' @name %>%
#' @rdname pipe
#' @keywords internal
#' @export
#' @importFrom magrittr %>%
#' @usage lhs \%>\% rhs
NULL
#' @export
magrittr::`%>%`
12 changes: 0 additions & 12 deletions man/pipe.Rd

This file was deleted.

16 changes: 16 additions & 0 deletions man/reexports.Rd

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

4 changes: 2 additions & 2 deletions man/show_columns.Rd

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

4 changes: 2 additions & 2 deletions man/show_rows.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/theme_grob.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/theme_htmlTable.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/theme_htmlWidget.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/theme_kable.Rd

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

0 comments on commit 693c075

Please sign in to comment.