From 147c1691379a4e06f98b281ee06d9b468f40b85f Mon Sep 17 00:00:00 2001 From: olivroy Date: Fri, 13 Oct 2023 09:47:16 -0400 Subject: [PATCH] Remove curly braces. add `\pkg` --- R/dm.R | 2 +- R/nycflights13.R | 2 +- R/pixarfilms.R | 2 +- R/zoom.R | 4 ++-- man/dm_nycflights13.Rd | 2 +- man/dm_pixarfilms.Rd | 2 +- man/dm_zoom_to.Rd | 4 ++-- man/glimpse.dm.Rd | 2 +- 8 files changed, 10 insertions(+), 10 deletions(-) diff --git a/R/dm.R b/R/dm.R index 9e31a478a..e6ebad0df 100644 --- a/R/dm.R +++ b/R/dm.R @@ -877,7 +877,7 @@ as.list.dm_zoomed <- function(x, ...) { #' keys, etc.) of all tables included in the `dm` object. It will additionally #' print details about outgoing foreign keys for the child table. #' -#' `glimpse()` is provided by the pillar package, and re-exported by {dm}. +#' `glimpse()` is provided by the pillar package, and re-exported by \pkg{dm}. #' See [pillar::glimpse()] for more details. #' #' @examples diff --git a/R/nycflights13.R b/R/nycflights13.R index 70ef74fbf..b36a01986 100644 --- a/R/nycflights13.R +++ b/R/nycflights13.R @@ -23,7 +23,7 @@ #' @param table_description Boolean, if `TRUE`, a description will be added for each table that will be displayed #' when drawing the table with [dm_draw()]. #' -#' @return A `dm` object consisting of {nycflights13} tables, complete with primary and foreign keys and optionally colored. +#' @return A `dm` object consisting of \pkg{nycflights13} tables, complete with primary and foreign keys and optionally colored. #' #' @export #' @seealso `vignette("howto-dm-df")` diff --git a/R/pixarfilms.R b/R/pixarfilms.R index fc733f584..afe7b2c56 100644 --- a/R/pixarfilms.R +++ b/R/pixarfilms.R @@ -12,7 +12,7 @@ #' `pixar_films` contains missing values so cannot be made a proper primary key. #' Set to `TRUE` to remove those records. #' -#' @return A `dm` object consisting of {pixarfilms} tables, complete with +#' @return A `dm` object consisting of \pkg{pixarfilms} tables, complete with #' primary and foreign keys and optionally colored. #' #' @export diff --git a/R/zoom.R b/R/zoom.R index 9f882b014..7c588df6a 100644 --- a/R/zoom.R +++ b/R/zoom.R @@ -31,13 +31,13 @@ #' Calling [filter()] on a zoomed `dm` is different from calling [dm_filter()]: #' only with the latter, the filter expression is added to the list of table filters stored in the dm. #' -#' Furthermore, different `join()`-variants from {dplyr} are also supported, +#' Furthermore, different `join()`-variants from \pkg{dplyr} are also supported, #' e.g. [left_join()] and [semi_join()]. #' (Support for [nest_join()] is planned.) #' The join-methods for `dm_zoomed` infer the columns to join by from the primary and foreign keys, #' and have an extra argument `select` that allows choosing the columns of the RHS table. #' -#' And -- last but not least -- also the {tidyr}-functions [unite()] and [separate()] are supported for `dm_zoomed`. +#' And -- last but not least -- also the \pkg{tidyr}-functions [unite()] and [separate()] are supported for `dm_zoomed`. #' #' @rdname dm_zoom_to #' @aliases zoomed_df diff --git a/man/dm_nycflights13.Rd b/man/dm_nycflights13.Rd index 9af4847b9..208a227aa 100644 --- a/man/dm_nycflights13.Rd +++ b/man/dm_nycflights13.Rd @@ -35,7 +35,7 @@ because this requires compound keys.} when drawing the table with \code{\link[=dm_draw]{dm_draw()}}.} } \value{ -A \code{dm} object consisting of {nycflights13} tables, complete with primary and foreign keys and optionally colored. +A \code{dm} object consisting of \pkg{nycflights13} tables, complete with primary and foreign keys and optionally colored. } \description{ Creates an example \code{\link{dm}} object from the tables in \pkg{nycflights13}, diff --git a/man/dm_pixarfilms.Rd b/man/dm_pixarfilms.Rd index 6ea999ff4..de41d62ff 100644 --- a/man/dm_pixarfilms.Rd +++ b/man/dm_pixarfilms.Rd @@ -18,7 +18,7 @@ have colors assigned to different tables for visualization with Set to \code{TRUE} to remove those records.} } \value{ -A \code{dm} object consisting of {pixarfilms} tables, complete with +A \code{dm} object consisting of \pkg{pixarfilms} tables, complete with primary and foreign keys and optionally colored. } \description{ diff --git a/man/dm_zoom_to.Rd b/man/dm_zoom_to.Rd index 0bffaa966..85d31e7ad 100644 --- a/man/dm_zoom_to.Rd +++ b/man/dm_zoom_to.Rd @@ -89,13 +89,13 @@ with a normal table. Calling \code{\link[=filter]{filter()}} on a zoomed \code{dm} is different from calling \code{\link[=dm_filter]{dm_filter()}}: only with the latter, the filter expression is added to the list of table filters stored in the dm. -Furthermore, different \code{join()}-variants from {dplyr} are also supported, +Furthermore, different \code{join()}-variants from \pkg{dplyr} are also supported, e.g. \code{\link[=left_join]{left_join()}} and \code{\link[=semi_join]{semi_join()}}. (Support for \code{\link[=nest_join]{nest_join()}} is planned.) The join-methods for \code{dm_zoomed} infer the columns to join by from the primary and foreign keys, and have an extra argument \code{select} that allows choosing the columns of the RHS table. -And -- last but not least -- also the {tidyr}-functions \code{\link[=unite]{unite()}} and \code{\link[=separate]{separate()}} are supported for \code{dm_zoomed}. +And -- last but not least -- also the \pkg{tidyr}-functions \code{\link[=unite]{unite()}} and \code{\link[=separate]{separate()}} are supported for \code{dm_zoomed}. } \examples{ \dontshow{if (rlang::is_installed("nycflights13") && rlang::is_installed("DiagrammeR")) (if (getRversion() >= "3.4") withAutoprint else force)(\{ # examplesIf} diff --git a/man/glimpse.dm.Rd b/man/glimpse.dm.Rd index 6baa95ce5..fb611e478 100644 --- a/man/glimpse.dm.Rd +++ b/man/glimpse.dm.Rd @@ -22,7 +22,7 @@ printing. If \code{NULL}, \code{getOption("width")} will be consulted.} keys, etc.) of all tables included in the \code{dm} object. It will additionally print details about outgoing foreign keys for the child table. -\code{glimpse()} is provided by the pillar package, and re-exported by {dm}. +\code{glimpse()} is provided by the pillar package, and re-exported by \pkg{dm}. See \code{\link[pillar:glimpse]{pillar::glimpse()}} for more details. } \examples{