Skip to content

Commit

Permalink
Escape braces in doc
Browse files Browse the repository at this point in the history
  • Loading branch information
phgrosjean committed May 1, 2024
1 parent 6ef4796 commit 2c4d9a5
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion R/collect_dtx.R
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#' Force computation of a lazy tidyverse object
#'
#' @description When \{dplyr\} or \{tidyr\} verbs are applied to a **data.table** or a database connection, they do not output data frames but objects like **dtplyr_step** or **tbl_sql** that are called lazy data frames. The actual process is triggered by using [as_dtx()], or more explicitly with [dplyr::collect()] which coerces the result to a **tibble**. If you want the default {svBase} data frame object instead, use [collect_dtx()], or if you want a specific object, use one of the other variants.
#' @description When \{dplyr\} or \{tidyr\} verbs are applied to a **data.table** or a database connection, they do not output data frames but objects like **dtplyr_step** or **tbl_sql** that are called lazy data frames. The actual process is triggered by using [as_dtx()], or more explicitly with [dplyr::collect()] which coerces the result to a **tibble**. If you want the default \{svBase\} data frame object instead, use [collect_dtx()], or if you want a specific object, use one of the other variants.
#'
#' @param x A data.frame, data.table, tibble or a lazy data frame (dtplyr_step, tbl_sql...).
#' @param ... Arguments passed on to methods for [dplyr::collect()].
Expand Down
2 changes: 1 addition & 1 deletion man/collect_dtx.Rd

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

0 comments on commit 2c4d9a5

Please sign in to comment.