From a421ab28bab37059ec2d5cd08c3789ac5ca2af64 Mon Sep 17 00:00:00 2001 From: Hadley Wickham Date: Fri, 29 Nov 2024 13:54:12 -0600 Subject: [PATCH] Better cross-package links With dev roxygen2 --- DESCRIPTION | 2 +- R/verb-count.R | 2 +- man/arrange.tbl_lazy.Rd | 4 ++-- man/backend-hana.Rd | 2 +- man/collapse.tbl_sql.Rd | 4 ++-- man/complete.tbl_lazy.Rd | 4 ++-- man/copy_inline.Rd | 4 ++-- man/copy_to.src_sql.Rd | 4 ++-- man/count.tbl_lazy.Rd | 2 +- man/db-sql.Rd | 2 +- man/dbplyr-slice.Rd | 4 ++-- man/distinct.tbl_lazy.Rd | 4 ++-- man/expand.tbl_lazy.Rd | 4 ++-- man/fill.tbl_lazy.Rd | 2 +- man/filter.tbl_lazy.Rd | 4 ++-- man/get_returned_rows.Rd | 8 ++++---- man/group_by.tbl_lazy.Rd | 2 +- man/head.tbl_lazy.Rd | 2 +- man/join.tbl_sql.Rd | 6 +++--- man/mutate.tbl_lazy.Rd | 4 ++-- man/nycflights13.Rd | 2 +- man/pivot_longer.tbl_lazy.Rd | 2 +- man/pivot_wider.tbl_lazy.Rd | 4 ++-- man/pull.tbl_sql.Rd | 2 +- man/replace_na.tbl_lazy.Rd | 4 ++-- man/rows-db.Rd | 8 ++++---- man/select.tbl_lazy.Rd | 2 +- man/summarise.tbl_lazy.Rd | 4 ++-- man/tbl.src_dbi.Rd | 10 +++++----- man/win_over.Rd | 2 +- 30 files changed, 55 insertions(+), 55 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index fb1835022..4a18dff6f 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -58,7 +58,7 @@ Config/testthat/parallel: TRUE Encoding: UTF-8 Language: en-gb Roxygen: list(markdown = TRUE) -RoxygenNote: 7.3.1 +RoxygenNote: 7.3.2.9000 Collate: 'db-sql.R' 'utils-check.R' diff --git a/R/verb-count.R b/R/verb-count.R index 9c313b2dc..81cac53f4 100644 --- a/R/verb-count.R +++ b/R/verb-count.R @@ -1,6 +1,6 @@ #' Count observations by group #' -#' These are methods for the dplyr [count()] and [tally()] generics. They +#' These are methods for the dplyr [dplyr::count()] and [tally()] generics. They #' wrap up [group_by.tbl_lazy()], [summarise.tbl_lazy()] and, optionally, #' [arrange.tbl_lazy()]. #' diff --git a/man/arrange.tbl_lazy.Rd b/man/arrange.tbl_lazy.Rd index 5f288aa87..c2f0e6de8 100644 --- a/man/arrange.tbl_lazy.Rd +++ b/man/arrange.tbl_lazy.Rd @@ -17,12 +17,12 @@ order.} grouped data frames only.} } \value{ -Another \code{tbl_lazy}. Use \code{\link[=show_query]{show_query()}} to see the generated +Another \code{tbl_lazy}. Use \code{\link[dplyr:explain]{dplyr::show_query()}} to see the generated query, and use \code{\link[=collect.tbl_sql]{collect()}} to execute the query and return data to R. } \description{ -This is an method for the dplyr \code{\link[=arrange]{arrange()}} generic. It generates +This is an method for the dplyr \code{\link[dplyr:arrange]{dplyr::arrange()}} generic. It generates the \verb{ORDER BY} clause of the SQL query. It also affects the \code{\link[=window_order]{window_order()}} of windowed expressions in \code{\link[=mutate.tbl_lazy]{mutate.tbl_lazy()}}. diff --git a/man/backend-hana.Rd b/man/backend-hana.Rd index e39ab5497..f57366959 100644 --- a/man/backend-hana.Rd +++ b/man/backend-hana.Rd @@ -12,7 +12,7 @@ details of overall translation technology. Key differences for this backend are: \itemize{ \item Temporary tables get \verb{#} prefix and use \verb{LOCAL TEMPORARY COLUMN}. -\item No table analysis performed in \code{\link[=copy_to]{copy_to()}}. +\item No table analysis performed in \code{\link[dplyr:copy_to]{dplyr::copy_to()}}. \item \code{paste()} uses \code{||} \item Note that you can't create new boolean columns from logical expressions; you need to wrap with explicit \code{ifelse}: \code{ifelse(x > y, TRUE, FALSE)}. diff --git a/man/collapse.tbl_sql.Rd b/man/collapse.tbl_sql.Rd index c93a83aa2..d5f721e27 100644 --- a/man/collapse.tbl_sql.Rd +++ b/man/collapse.tbl_sql.Rd @@ -49,8 +49,8 @@ Use common table expressions in the generated SQL?} \item{warn_incomplete}{Warn if \code{n} is less than the number of result rows?} } \description{ -These are methods for the dplyr generics \code{\link[=collapse]{collapse()}}, \code{\link[=compute]{compute()}}, -and \code{\link[=collect]{collect()}}. \code{collapse()} creates a subquery, \code{compute()} stores +These are methods for the dplyr generics \code{\link[dplyr:compute]{dplyr::collapse()}}, \code{\link[dplyr:compute]{dplyr::compute()}}, +and \code{\link[dplyr:compute]{dplyr::collect()}}. \code{collapse()} creates a subquery, \code{compute()} stores the results in a remote table, and \code{collect()} executes the query and downloads the data into R. } diff --git a/man/complete.tbl_lazy.Rd b/man/complete.tbl_lazy.Rd index a311fda44..8fd60355b 100644 --- a/man/complete.tbl_lazy.Rd +++ b/man/complete.tbl_lazy.Rd @@ -16,7 +16,7 @@ more details.} use instead of NA for missing combinations.} } \value{ -Another \code{tbl_lazy}. Use \code{\link[=show_query]{show_query()}} to see the generated +Another \code{tbl_lazy}. Use \code{\link[dplyr:explain]{dplyr::show_query()}} to see the generated query, and use \code{\link[=collect.tbl_sql]{collect()}} to execute the query and return data to R. } @@ -25,7 +25,7 @@ Turns implicit missing values into explicit missing values. This is a method for the \code{\link[tidyr:complete]{tidyr::complete()}} generic. } \examples{ -\dontshow{if (rlang::is_installed("tidyr", version = "1.0.0")) (if (getRversion() >= "3.4") withAutoprint else force)(\{ # examplesIf} +\dontshow{if (rlang::is_installed("tidyr", version = "1.0.0")) withAutoprint(\{ # examplesIf} df <- memdb_frame( group = c(1:2, 1), item_id = c(1:2, 2), diff --git a/man/copy_inline.Rd b/man/copy_inline.Rd index c1880b92c..e9d22d79d 100644 --- a/man/copy_inline.Rd +++ b/man/copy_inline.Rd @@ -21,7 +21,7 @@ If \code{NULL}, the default, the types are determined from \code{df}.} A \code{tbl_lazy}. } \description{ -This is an alternative to \code{\link[=copy_to]{copy_to()}} that does not need write access and +This is an alternative to \code{\link[dplyr:copy_to]{dplyr::copy_to()}} that does not need write access and is faster for small data. } \details{ @@ -36,5 +36,5 @@ copy_inline(con, df) copy_inline(con, df) \%>\% dplyr::show_query() } \seealso{ -\code{\link[=copy_to]{copy_to()}} to copy the data into a new database table. +\code{\link[dplyr:copy_to]{dplyr::copy_to()}} to copy the data into a new database table. } diff --git a/man/copy_to.src_sql.Rd b/man/copy_to.src_sql.Rd index c7d8f4a1a..6376c4e60 100644 --- a/man/copy_to.src_sql.Rd +++ b/man/copy_to.src_sql.Rd @@ -59,12 +59,12 @@ database doesn't support transactions, or you're wrapping in a transaction higher up (and your database doesn't support nested transactions.)} } \value{ -Another \code{tbl_lazy}. Use \code{\link[=show_query]{show_query()}} to see the generated +Another \code{tbl_lazy}. Use \code{\link[dplyr:explain]{dplyr::show_query()}} to see the generated query, and use \code{\link[=collect.tbl_sql]{collect()}} to execute the query and return data to R. } \description{ -This is an implementation of the dplyr \code{\link[=copy_to]{copy_to()}} generic and it mostly +This is an implementation of the dplyr \code{\link[dplyr:copy_to]{dplyr::copy_to()}} generic and it mostly a wrapper around \code{\link[DBI:dbWriteTable]{DBI::dbWriteTable()}}. It is useful for copying small amounts of data to a database for examples, diff --git a/man/count.tbl_lazy.Rd b/man/count.tbl_lazy.Rd index ce01629a9..7a1ddcc1f 100644 --- a/man/count.tbl_lazy.Rd +++ b/man/count.tbl_lazy.Rd @@ -38,7 +38,7 @@ it will use \code{nn}. If there's a column called \code{n} and \code{nn}, it'll \item{.drop}{Not supported for lazy tables.} } \description{ -These are methods for the dplyr \code{\link[=count]{count()}} and \code{\link[=tally]{tally()}} generics. They +These are methods for the dplyr \code{\link[dplyr:count]{dplyr::count()}} and \code{\link[dplyr:count]{dplyr::tally()}} generics. They wrap up \code{\link[=group_by.tbl_lazy]{group_by.tbl_lazy()}}, \code{\link[=summarise.tbl_lazy]{summarise.tbl_lazy()}} and, optionally, \code{\link[=arrange.tbl_lazy]{arrange.tbl_lazy()}}. } diff --git a/man/db-sql.Rd b/man/db-sql.Rd index 6f7179e45..c1aec3dea 100644 --- a/man/db-sql.Rd +++ b/man/db-sql.Rd @@ -114,7 +114,7 @@ Tables: \itemize{ \item \code{sql_table_analyze(con, table)} generates SQL that "analyzes" the table, ensuring that the database has up-to-date statistics for use in the query -planner. It called from \code{\link[=copy_to]{copy_to()}} when \code{analyze = TRUE}. +planner. It called from \code{\link[dplyr:copy_to]{dplyr::copy_to()}} when \code{analyze = TRUE}. \item \code{sql_table_index()} generates SQL for adding an index to table. } diff --git a/man/dbplyr-slice.Rd b/man/dbplyr-slice.Rd index 80a581773..8b3f9524d 100644 --- a/man/dbplyr-slice.Rd +++ b/man/dbplyr-slice.Rd @@ -63,8 +63,8 @@ reach \code{n}/\code{prop}.} \item{weight_by, replace}{Not supported for database backends.} } \description{ -These are methods for the dplyr generics \code{\link[=slice_min]{slice_min()}}, \code{\link[=slice_max]{slice_max()}}, and -\code{\link[=slice_sample]{slice_sample()}}. They are translated to SQL using \code{\link[=filter]{filter()}} and +These are methods for the dplyr generics \code{\link[dplyr:slice]{dplyr::slice_min()}}, \code{\link[dplyr:slice]{dplyr::slice_max()}}, and +\code{\link[dplyr:slice]{dplyr::slice_sample()}}. They are translated to SQL using \code{\link[dplyr:filter]{dplyr::filter()}} and window functions (\code{ROWNUMBER}, \code{MIN_RANK}, or \code{CUME_DIST} depending on arguments). \code{slice()}, \code{slice_head()}, and \code{slice_tail()} are not supported since database tables have no intrinsic order. diff --git a/man/distinct.tbl_lazy.Rd b/man/distinct.tbl_lazy.Rd index 003848b98..6a272da73 100644 --- a/man/distinct.tbl_lazy.Rd +++ b/man/distinct.tbl_lazy.Rd @@ -18,12 +18,12 @@ If a combination of \code{...} is not distinct, this keeps the first row of values.} } \value{ -Another \code{tbl_lazy}. Use \code{\link[=show_query]{show_query()}} to see the generated +Another \code{tbl_lazy}. Use \code{\link[dplyr:explain]{dplyr::show_query()}} to see the generated query, and use \code{\link[=collect.tbl_sql]{collect()}} to execute the query and return data to R. } \description{ -This is a method for the dplyr \code{\link[=distinct]{distinct()}} generic. It adds the +This is a method for the dplyr \code{\link[dplyr:distinct]{dplyr::distinct()}} generic. It adds the \code{DISTINCT} clause to the SQL query. } \examples{ diff --git a/man/expand.tbl_lazy.Rd b/man/expand.tbl_lazy.Rd index 407cde89a..67a9dc14a 100644 --- a/man/expand.tbl_lazy.Rd +++ b/man/expand.tbl_lazy.Rd @@ -29,7 +29,7 @@ See there for more details on these terms and the strategies used to enforce them.} } \value{ -Another \code{tbl_lazy}. Use \code{\link[=show_query]{show_query()}} to see the generated +Another \code{tbl_lazy}. Use \code{\link[dplyr:explain]{dplyr::show_query()}} to see the generated query, and use \code{\link[=collect.tbl_sql]{collect()}} to execute the query and return data to R. } @@ -39,7 +39,7 @@ result explicitly, so the order might be different to what \code{expand()} returns for data frames. } \examples{ -\dontshow{if (rlang::is_installed("tidyr", version = "1.0.0")) (if (getRversion() >= "3.4") withAutoprint else force)(\{ # examplesIf} +\dontshow{if (rlang::is_installed("tidyr", version = "1.0.0")) withAutoprint(\{ # examplesIf} fruits <- memdb_frame( type = c("apple", "orange", "apple", "orange", "orange", "orange"), year = c(2010, 2010, 2012, 2010, 2010, 2012), diff --git a/man/fill.tbl_lazy.Rd b/man/fill.tbl_lazy.Rd index fdcaca4ae..ca2dd7c0c 100644 --- a/man/fill.tbl_lazy.Rd +++ b/man/fill.tbl_lazy.Rd @@ -21,7 +21,7 @@ yourself beforehand; for example replace \code{arrange(x, desc(y))} by Fill in missing values with previous or next value } \examples{ -\dontshow{if (rlang::is_installed("tidyr", version = "1.0.0")) (if (getRversion() >= "3.4") withAutoprint else force)(\{ # examplesIf} +\dontshow{if (rlang::is_installed("tidyr", version = "1.0.0")) withAutoprint(\{ # examplesIf} squirrels <- tibble::tribble( ~group, ~name, ~role, ~n_squirrels, ~ n_squirrels2, 1, "Sam", "Observer", NA, 1, diff --git a/man/filter.tbl_lazy.Rd b/man/filter.tbl_lazy.Rd index 20bbb6938..c6a10f964 100644 --- a/man/filter.tbl_lazy.Rd +++ b/man/filter.tbl_lazy.Rd @@ -22,12 +22,12 @@ details and examples, see \link[dplyr:dplyr_by]{?dplyr_by}.} \item{.preserve}{Not supported by this method.} } \value{ -Another \code{tbl_lazy}. Use \code{\link[=show_query]{show_query()}} to see the generated +Another \code{tbl_lazy}. Use \code{\link[dplyr:explain]{dplyr::show_query()}} to see the generated query, and use \code{\link[=collect.tbl_sql]{collect()}} to execute the query and return data to R. } \description{ -This is a method for the dplyr \code{\link[=filter]{filter()}} generic. It generates the +This is a method for the dplyr \code{\link[dplyr:filter]{dplyr::filter()}} generic. It generates the \code{WHERE} clause of the SQL query. } \examples{ diff --git a/man/get_returned_rows.Rd b/man/get_returned_rows.Rd index 0714418cb..1d8801265 100644 --- a/man/get_returned_rows.Rd +++ b/man/get_returned_rows.Rd @@ -21,13 +21,13 @@ For \code{has_returned_rows()}, a scalar logical. \ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} \code{get_returned_rows()} extracts the \code{RETURNING} rows produced by -\code{\link[=rows_insert]{rows_insert()}}, \code{\link[=rows_append]{rows_append()}}, \code{\link[=rows_update]{rows_update()}}, \code{\link[=rows_upsert]{rows_upsert()}}, -or \code{\link[=rows_delete]{rows_delete()}} if these are called with the \code{returning} argument. +\code{\link[dplyr:rows]{dplyr::rows_insert()}}, \code{\link[dplyr:rows]{dplyr::rows_append()}}, \code{\link[dplyr:rows]{dplyr::rows_update()}}, \code{\link[dplyr:rows]{dplyr::rows_upsert()}}, +or \code{\link[dplyr:rows]{dplyr::rows_delete()}} if these are called with the \code{returning} argument. An error is raised if this information is not available. \code{has_returned_rows()} checks if \code{x} has stored RETURNING rows produced by -\code{\link[=rows_insert]{rows_insert()}}, \code{\link[=rows_append]{rows_append()}}, \code{\link[=rows_update]{rows_update()}}, \code{\link[=rows_upsert]{rows_upsert()}}, -or \code{\link[=rows_delete]{rows_delete()}}. +\code{\link[dplyr:rows]{dplyr::rows_insert()}}, \code{\link[dplyr:rows]{dplyr::rows_append()}}, \code{\link[dplyr:rows]{dplyr::rows_update()}}, \code{\link[dplyr:rows]{dplyr::rows_upsert()}}, +or \code{\link[dplyr:rows]{dplyr::rows_delete()}}. } \examples{ library(dplyr) diff --git a/man/group_by.tbl_lazy.Rd b/man/group_by.tbl_lazy.Rd index 1c4cf1f97..5dc1d6abd 100644 --- a/man/group_by.tbl_lazy.Rd +++ b/man/group_by.tbl_lazy.Rd @@ -26,7 +26,7 @@ our naming conventions.} \item{.drop}{Not supported by this method.} } \description{ -This is a method for the dplyr \code{\link[=group_by]{group_by()}} generic. It is translated to +This is a method for the dplyr \code{\link[dplyr:group_by]{dplyr::group_by()}} generic. It is translated to the \verb{GROUP BY} clause of the SQL query when used with \code{\link[=summarise.tbl_lazy]{summarise()}} and to the \verb{PARTITION BY} clause of window functions when used with \code{\link[=mutate.tbl_lazy]{mutate()}}. diff --git a/man/head.tbl_lazy.Rd b/man/head.tbl_lazy.Rd index f87dbcf2b..4fcd5fdda 100644 --- a/man/head.tbl_lazy.Rd +++ b/man/head.tbl_lazy.Rd @@ -14,7 +14,7 @@ \item{...}{Not used.} } \value{ -Another \code{tbl_lazy}. Use \code{\link[=show_query]{show_query()}} to see the generated +Another \code{tbl_lazy}. Use \code{\link[dplyr:explain]{dplyr::show_query()}} to see the generated query, and use \code{\link[=collect.tbl_sql]{collect()}} to execute the query and return data to R. } diff --git a/man/join.tbl_sql.Rd b/man/join.tbl_sql.Rd index fbb4336fd..cb9e2221b 100644 --- a/man/join.tbl_sql.Rd +++ b/man/join.tbl_sql.Rd @@ -180,7 +180,7 @@ inequality conditions. \item{na_matches}{Should NA (NULL) values match one another? The default, "never", is how databases usually work. \code{"na"} makes -the joins behave like the dplyr join functions, \code{\link[=merge]{merge()}}, \code{\link[=match]{match()}}, +the joins behave like the dplyr join functions, \code{\link[=merge]{merge()}}, \code{\link[bit64:bit64S3]{bit64::match()}}, and \code{\%in\%}.} \item{multiple, unmatched}{Unsupported in database backends. As a workaround @@ -202,12 +202,12 @@ there are matching indexes in \code{x}.} \code{"RHS"}} } \value{ -Another \code{tbl_lazy}. Use \code{\link[=show_query]{show_query()}} to see the generated +Another \code{tbl_lazy}. Use \code{\link[dplyr:explain]{dplyr::show_query()}} to see the generated query, and use \code{\link[=collect.tbl_sql]{collect()}} to execute the query and return data to R. } \description{ -These are methods for the dplyr \link{join} generics. They are translated +These are methods for the dplyr \link[dplyr:mutate-joins]{dplyr::join} generics. They are translated to the following SQL queries: \itemize{ \item \code{inner_join(x, y)}: \verb{SELECT * FROM x JOIN y ON x.a = y.a} diff --git a/man/mutate.tbl_lazy.Rd b/man/mutate.tbl_lazy.Rd index 35f4db4d1..3072f34ac 100644 --- a/man/mutate.tbl_lazy.Rd +++ b/man/mutate.tbl_lazy.Rd @@ -45,12 +45,12 @@ should appear (the default is to add to the right hand side). See \code{\link[dplyr:relocate]{relocate()}} for more details.} } \value{ -Another \code{tbl_lazy}. Use \code{\link[=show_query]{show_query()}} to see the generated +Another \code{tbl_lazy}. Use \code{\link[dplyr:explain]{dplyr::show_query()}} to see the generated query, and use \code{\link[=collect.tbl_sql]{collect()}} to execute the query and return data to R. } \description{ -These are methods for the dplyr \code{\link[=mutate]{mutate()}} and \code{\link[=transmute]{transmute()}} generics. +These are methods for the dplyr \code{\link[dplyr:mutate]{dplyr::mutate()}} and \code{\link[dplyr:transmute]{dplyr::transmute()}} generics. They are translated to computed expressions in the \code{SELECT} clause of the SQL query. } diff --git a/man/nycflights13.Rd b/man/nycflights13.Rd index 498c337a3..ad6560937 100644 --- a/man/nycflights13.Rd +++ b/man/nycflights13.Rd @@ -19,7 +19,7 @@ copy_nycflights13(con, ...) \arguments{ \item{path}{location of SQLite database file} -\item{dbname, ...}{Arguments passed on to \code{\link[=src_postgres]{src_postgres()}}} +\item{dbname, ...}{Arguments passed on to \code{\link[dplyr:src_dbi]{dplyr::src_postgres()}}} } \description{ These functions cache the data from the \code{nycflights13} database in diff --git a/man/pivot_longer.tbl_lazy.Rd b/man/pivot_longer.tbl_lazy.Rd index 0bd531529..3963e10f8 100644 --- a/man/pivot_longer.tbl_lazy.Rd +++ b/man/pivot_longer.tbl_lazy.Rd @@ -93,7 +93,7 @@ following columns } } \examples{ -\dontshow{if (rlang::is_installed("tidyr", version = "1.0.0")) (if (getRversion() >= "3.4") withAutoprint else force)(\{ # examplesIf} +\dontshow{if (rlang::is_installed("tidyr", version = "1.0.0")) withAutoprint(\{ # examplesIf} # See vignette("pivot") for examples and explanation # Simplest case where column names are character data diff --git a/man/pivot_wider.tbl_lazy.Rd b/man/pivot_wider.tbl_lazy.Rd index 4e06b2e8f..73cd94f7d 100644 --- a/man/pivot_wider.tbl_lazy.Rd +++ b/man/pivot_wider.tbl_lazy.Rd @@ -78,7 +78,7 @@ naming scheme of the form: \verb{value1_name1, value2_name1, value1_name2, value }} \item{names_expand}{Should the values in the \code{names_from} columns be expanded -by \code{\link[=expand]{expand()}} before pivoting? This results in more columns, the output +by \code{\link[tidyr:expand]{tidyr::expand()}} before pivoting? This results in more columns, the output will contain column names corresponding to a complete expansion of all possible values in \code{names_from}. Additionally, the column names will be sorted, identical to what \code{names_sort} would produce.} @@ -164,7 +164,7 @@ The translation to SQL code basically works as follows: } } \examples{ -\dontshow{if (rlang::is_installed("tidyr", version = "1.0.0")) (if (getRversion() >= "3.4") withAutoprint else force)(\{ # examplesIf} +\dontshow{if (rlang::is_installed("tidyr", version = "1.0.0")) withAutoprint(\{ # examplesIf} memdb_frame( id = 1, key = c("x", "y"), diff --git a/man/pull.tbl_sql.Rd b/man/pull.tbl_sql.Rd index 836483f3f..450c485fa 100644 --- a/man/pull.tbl_sql.Rd +++ b/man/pull.tbl_sql.Rd @@ -34,7 +34,7 @@ order.} A vector of data. } \description{ -This is a method for the dplyr \code{\link[=pull]{pull()}} generic. It evaluates the query +This is a method for the dplyr \code{\link[dplyr:pull]{dplyr::pull()}} generic. It evaluates the query retrieving just the specified column. } \examples{ diff --git a/man/replace_na.tbl_lazy.Rd b/man/replace_na.tbl_lazy.Rd index 1393be178..3c8ffe0fe 100644 --- a/man/replace_na.tbl_lazy.Rd +++ b/man/replace_na.tbl_lazy.Rd @@ -15,7 +15,7 @@ has NA values to be replaced.} \item{...}{Unused; included for compatibility with generic.} } \value{ -Another \code{tbl_lazy}. Use \code{\link[=show_query]{show_query()}} to see the generated +Another \code{tbl_lazy}. Use \code{\link[dplyr:explain]{dplyr::show_query()}} to see the generated query, and use \code{\link[=collect.tbl_sql]{collect()}} to execute the query and return data to R. } @@ -23,7 +23,7 @@ and return data to R. This is a method for the \code{\link[tidyr:replace_na]{tidyr::replace_na()}} generic. } \examples{ -\dontshow{if (rlang::is_installed("tidyr", version = "1.0.0")) (if (getRversion() >= "3.4") withAutoprint else force)(\{ # examplesIf} +\dontshow{if (rlang::is_installed("tidyr", version = "1.0.0")) withAutoprint(\{ # examplesIf} df <- memdb_frame(x = c(1, 2, NA), y = c("a", NA, "b")) df \%>\% tidyr::replace_na(list(x = 0, y = "unknown")) \dontshow{\}) # examplesIf} diff --git a/man/rows-db.Rd b/man/rows-db.Rd index a8face789..153beefc0 100644 --- a/man/rows-db.Rd +++ b/man/rows-db.Rd @@ -69,8 +69,8 @@ } \arguments{ \item{x}{A lazy table. -For \code{in_place = TRUE}, this must be a table instantiated with \code{\link[=tbl]{tbl()}} or -\code{\link[=compute]{compute()}}, not to a lazy query. The \code{\link[=remote_name]{remote_name()}} function is used to +For \code{in_place = TRUE}, this must be a table instantiated with \code{\link[dplyr:tbl]{dplyr::tbl()}} or +\code{\link[dplyr:compute]{dplyr::compute()}}, not to a lazy query. The \code{\link[=remote_name]{remote_name()}} function is used to determine the name of the table to be updated.} \item{y}{A lazy table, data frame, or data frame extensions (e.g. a tibble).} @@ -134,8 +134,8 @@ because the purpose of this operation is the side effect of modifying rows in the table behind \code{x}. } \description{ -These are methods for the dplyr \code{\link[=rows_insert]{rows_insert()}}, \code{\link[=rows_append]{rows_append()}}, -\code{\link[=rows_update]{rows_update()}}, \code{\link[=rows_patch]{rows_patch()}}, \code{\link[=rows_upsert]{rows_upsert()}}, and \code{\link[=rows_delete]{rows_delete()}} +These are methods for the dplyr \code{\link[dplyr:rows]{dplyr::rows_insert()}}, \code{\link[dplyr:rows]{dplyr::rows_append()}}, +\code{\link[dplyr:rows]{dplyr::rows_update()}}, \code{\link[dplyr:rows]{dplyr::rows_patch()}}, \code{\link[dplyr:rows]{dplyr::rows_upsert()}}, and \code{\link[dplyr:rows]{dplyr::rows_delete()}} generics. When \code{in_place = TRUE} these verbs do not generate \code{SELECT} queries, but diff --git a/man/select.tbl_lazy.Rd b/man/select.tbl_lazy.Rd index ab6e70e3f..417c02384 100644 --- a/man/select.tbl_lazy.Rd +++ b/man/select.tbl_lazy.Rd @@ -33,7 +33,7 @@ columns selected by \code{...}. Supplying neither will move columns to the left-hand side; specifying both is an error.} } \description{ -These are methods for the dplyr \code{\link[=select]{select()}}, \code{\link[=rename]{rename()}}, and \code{\link[=relocate]{relocate()}} +These are methods for the dplyr \code{\link[dplyr:select]{dplyr::select()}}, \code{\link[dplyr:rename]{dplyr::rename()}}, and \code{\link[dplyr:relocate]{dplyr::relocate()}} generics. They generate the \code{SELECT} clause of the SQL query. These functions do not support predicate functions, i.e. you can diff --git a/man/summarise.tbl_lazy.Rd b/man/summarise.tbl_lazy.Rd index 2dc2a169a..33246641e 100644 --- a/man/summarise.tbl_lazy.Rd +++ b/man/summarise.tbl_lazy.Rd @@ -34,12 +34,12 @@ the option "dplyr.summarise.inform" is set to \code{FALSE}, or when \code{summarise()} is called from a function in a package.} } \value{ -Another \code{tbl_lazy}. Use \code{\link[=show_query]{show_query()}} to see the generated +Another \code{tbl_lazy}. Use \code{\link[dplyr:explain]{dplyr::show_query()}} to see the generated query, and use \code{\link[=collect.tbl_sql]{collect()}} to execute the query and return data to R. } \description{ -This is a method for the dplyr \code{\link[=summarise]{summarise()}} generic. It generates the +This is a method for the dplyr \code{\link[dplyr:summarise]{dplyr::summarise()}} generic. It generates the \code{SELECT} clause of the SQL query, and generally needs to be combined with \code{group_by()}. } diff --git a/man/tbl.src_dbi.Rd b/man/tbl.src_dbi.Rd index 13c72f004..992d491bb 100644 --- a/man/tbl.src_dbi.Rd +++ b/man/tbl.src_dbi.Rd @@ -22,16 +22,16 @@ also use \code{\link[=in_schema]{in_schema()}}/\code{\link[=in_catalog]{in_catal \description{ All data manipulation on SQL tbls are lazy: they will not actually run the query or retrieve the data unless you ask for it: they all return -a new \code{tbl_dbi} object. Use \code{\link[=compute]{compute()}} to run the query and save the -results in a temporary table in the database, or use \code{\link[=collect]{collect()}} to retrieve the -results to R. You can see the query with \code{\link[=show_query]{show_query()}}. +a new \code{tbl_dbi} object. Use \code{\link[dplyr:compute]{dplyr::compute()}} to run the query and save the +results in a temporary table in the database, or use \code{\link[dplyr:compute]{dplyr::collect()}} to retrieve the +results to R. You can see the query with \code{\link[dplyr:explain]{dplyr::show_query()}}. } \details{ For best performance, the database should have an index on the variables -that you are grouping by. Use \code{\link[=explain]{explain()}} to check that the database is using +that you are grouping by. Use \code{\link[dplyr:explain]{dplyr::explain()}} to check that the database is using the indexes that you expect. -There is one verb that is not lazy: \code{\link[=do]{do()}} is eager because it must pull +There is one verb that is not lazy: \code{\link[dplyr:do]{dplyr::do()}} is eager because it must pull the data into R. } \examples{ diff --git a/man/win_over.Rd b/man/win_over.Rd index 39e1a5939..afdf020dc 100644 --- a/man/win_over.Rd +++ b/man/win_over.Rd @@ -58,7 +58,7 @@ win_rank_tdata(f) \code{win_absent()}, \code{win_rank()}, \code{win_aggregate()}, and \code{win_cumulative()} provide helpers for constructing common types of window functions. \code{win_current_group()} and \code{win_current_order()} allow you to access -the grouping and order context set up by \code{\link[=group_by]{group_by()}} and \code{\link[=arrange]{arrange()}}. +the grouping and order context set up by \code{\link[dplyr:group_by]{dplyr::group_by()}} and \code{\link[dplyr:arrange]{dplyr::arrange()}}. } \examples{ con <- simulate_dbi()