Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Tweak formatting #2232

Merged
merged 4 commits into from
Sep 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions R/db-interface.R
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#' Copy data model to data source
#'
#' @description
#' `copy_dm_to()` takes a [dplyr::src_dbi] object or a [`DBI::DBIConnection-class`] object as its first argument
#' `copy_dm_to()` takes a [`dplyr::src_dbi`] object or a [`DBI::DBIConnection-class`] object as its first argument
#' and a [`dm`] object as its second argument.
#' The latter is copied to the former.
#' The default is to create temporary tables, set `temporary = FALSE` to create permanent tables.
Expand All @@ -24,7 +24,7 @@
#'
#' Not all DBMS are supported.
#' @param table_names Desired names for the tables on `dest`; the names within the `dm` remain unchanged.
#' Can be `NULL`, a named character vector, or a vector of [DBI::Id] objects.
#' Can be `NULL`, a named character vector, or a vector of [`DBI::Id`] objects.
#'
#' If left `NULL` (default), the names will be determined automatically depending on the `temporary` argument:
#'
Expand Down
11 changes: 6 additions & 5 deletions R/select.R
Original file line number Diff line number Diff line change
@@ -1,22 +1,23 @@
#' Rename columns
#'
#' @description
#' Rename the columns of your [`dm`] using syntax that is similar to `dplyr::rename()`.
#' Rename the columns of your [`dm`] using syntax that is similar to [dplyr::rename()].
#'
#' @inheritParams dm_zoom_to
#' @param ... One or more unquoted expressions separated by commas.
#' You can treat
#' variable names as if they were positions, and use expressions like x:y
#' variable names as if they were positions, and use expressions like `x:y`
#' to select the ranges of variables.
#'
#' Use named arguments, e.g. new_name = old_name, to rename the selected variables.
#' Use named arguments, e.g. `new_name = old_name`, to rename the selected variables.
#'
#' The arguments in ... are automatically quoted and evaluated in a context where
#' column names represent column positions.
#' They also support unquoting and splicing.
#' See `vignette("programming", package = "dplyr")` for an introduction to those concepts.
#'
#' See select helpers for more details, and the examples about tidyselect helpers, such as starts_with(), everything(), ...
#' See select helpers for more details, and the examples about [tidyselect
#' helpers][tidyselect::select_helpers], such as `starts_with()`, `everything()`, etc.
#'
#' @details If key columns are renamed, then the meta-information of the `dm` is updated accordingly.
#'
Expand All @@ -39,7 +40,7 @@ dm_rename <- function(dm, table, ...) {
#' Select columns
#'
#' @description
#' Select columns of your [`dm`] using syntax that is similar to `dplyr::select()`.
#' Select columns of your [`dm`] using syntax that is similar to [dplyr::select()].
#'
#' @inheritParams dm_rename
#' @details If key columns are renamed, then the meta-information of the `dm` is updated accordingly.
Expand Down
2 changes: 1 addition & 1 deletion R/validate.R
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ dm_validate <- function(x) {

#' Validator
#'
#' `validate_dm()` has been replaced by `dm_validate()` for consistency.
#' `validate_dm()` has been replaced by [dm_validate()] for consistency.
#'
#' @param x An object.
#'
Expand Down
3 changes: 2 additions & 1 deletion R/zzx-deprecated.R
Original file line number Diff line number Diff line change
Expand Up @@ -749,7 +749,8 @@ dm_squash_to_tbl <- function(dm, start, ..., join = left_join) {

#' @description
#' `rows_truncate()` is deprecated as of dm 1.0.0, because it's a DDL operation
#' and requires different permissions than the `dplyr::rows_*()` functions.
#' and requires different permissions than the
#' [`dplyr::rows_*()`][dplyr::rows_insert()] functions.
#'
#' @rdname deprecated
#' @keywords internal
Expand Down
Loading