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

Fix CRAN cross reference note #290

Merged
merged 1 commit into from
Jan 8, 2025
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
1 change: 1 addition & 0 deletions R/dbAppendTable.R
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ NULL

#' @rdname PrestoConnection-class
#' @inheritParams DBI::dbAppendTable
#' @param conn a `PrestoConnection` object, as returned by [DBI::dbConnect()].
#' @usage NULL
.dbAppendTable <- function(
conn, name, value, ..., chunk.fields = NULL, row.names = NULL
Expand Down
4 changes: 2 additions & 2 deletions R/dbConnect.R
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ check_tz <- function(timezone) {
#' R's `double` type but might result in precision loss. Lastly,
#' `"character"` casts into R's `character` type.
#' @param ... currently ignored
#' @return [dbConnect] A [PrestoConnection-class] object
#' @return [DBI::dbConnect()] A [PrestoConnection-class] object
#' @importMethodsFrom DBI dbConnect
#' @importFrom methods new
#' @export
Expand Down Expand Up @@ -137,7 +137,7 @@ setMethod(
)

#' A dummy PrestoConnection
#'
#'
#' @export
#' @keywords internal
#' @examples
Expand Down
1 change: 1 addition & 0 deletions R/dbCreateTable.R
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ NULL

#' @rdname PrestoConnection-class
#' @inheritParams DBI::dbCreateTable
#' @param conn a `PrestoConnection` object, as returned by [DBI::dbConnect()].
#' @param with An optional WITH clause for the CREATE TABLE statement.
#' @usage NULL
.dbCreateTable <- function(conn, name, fields, with = NULL, ..., row.names = NULL, temporary = FALSE) {
Expand Down
2 changes: 1 addition & 1 deletion R/dbCreateTableAs.R
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ NULL

#' Create a table in database using a statement
#'
#' @inheritParams DBI::dbReadTable
#' @inheritParams sqlCreateTableAs
#' @param conn a `PrestoConnection` object, as returned by [DBI::dbConnect()].
#' @param sql a character string containing SQL statement.
#' @param overwrite A boolean indicating if an existing table should be
#' overwritten. Default to FALSE.
Expand Down
2 changes: 1 addition & 1 deletion R/dbDisconnect.R
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
NULL

#' @param conn A [PrestoConnection-class] object
#' @return [dbDisconnect] A [logical()] value indicating success
#' @return [DBI::dbDisconnect()] A [logical()] value indicating success
#' @importMethodsFrom DBI dbDisconnect
#' @export
#' @rdname Presto
Expand Down
1 change: 1 addition & 0 deletions R/dbListFields.R
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ NULL

#' @rdname PrestoConnection-class
#' @inheritParams DBI::dbListFields
#' @param conn a `PrestoConnection` object, as returned by [DBI::dbConnect()].
#' @usage NULL
.dbListFields_PrestoConnection <- function(conn, name, ...) {
name <- DBI::dbQuoteIdentifier(conn, name)
Expand Down
1 change: 1 addition & 0 deletions R/dbQuoteIdentifier.R
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ NULL

#' @rdname PrestoConnection-class
#' @inheritParams DBI::dbQuoteIdentifier
#' @param conn a `PrestoConnection` object, as returned by [DBI::dbConnect()].
#' @usage NULL
.dbQuoteIdentifier_PrestoConnection_dbplyr_schema <- function(conn, x, ...) {
x_id <- DBI::Id(
Expand Down
1 change: 1 addition & 0 deletions R/dbQuoteLiteral.R
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ NULL

#' @rdname PrestoConnection-class
#' @inheritParams DBI::dbQuoteLiteral
#' @param conn a `PrestoConnection` object, as returned by [DBI::dbConnect()].
#' @usage NULL
.dbQuoteLiteral <- function(conn, x, ...) {
if (methods::is(x, "SQL")) {
Expand Down
1 change: 1 addition & 0 deletions R/dbWriteTable.R
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ NULL

#' @rdname PrestoConnection-class
#' @inheritParams DBI::dbWriteTable
#' @param conn a `PrestoConnection` object, as returned by [DBI::dbConnect()].
#' @param chunk.fields A character vector of names of the fields that should
#' be used to slice the value data frame into chunks for batch append. This is
#' necessary when the data frame is too big to be uploaded at once in one
Expand Down
2 changes: 1 addition & 1 deletion R/default.R
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ presto_default <- function(...) {
#' `dbConnect(Presto(), ...)`. This function checks if that
#' database is available, and if not, displays an informative message.
#'
#' @param ... Additional arguments passed on to [dbConnect()]
#' @param ... Additional arguments passed on to [DBI::dbConnect()]
#' @export
#' @examples
#' if (presto_has_default()) {
Expand Down
6 changes: 3 additions & 3 deletions R/sqlCreateTableAs.R
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@ NULL
#' Compose query to create a simple table using a statement
#'
#' @param con A database connection.
#' @param name The table name, passed on to [dbQuoteIdentifier()]. Options are:
#' @param name The table name, passed on to [DBI::dbQuoteIdentifier()]. Options are:
#' - a character string with the unquoted DBMS table name,
#' e.g. `"table_name"`,
#' - a call to [Id()] with components to the fully qualified table name,
#' - a call to [DBI::Id()] with components to the fully qualified table name,
#' e.g. `Id(schema = "my_schema", table = "table_name")`
#' - a call to [SQL()] with the quoted and fully qualified table name
#' - a call to [DBI::SQL()] with the quoted and fully qualified table name
#' given verbatim, e.g. `SQL('"my_schema"."table_name"')`
#' @param sql a character string containing SQL statement.
#' @param with An optional WITH clause for the CREATE TABLE statement.
Expand Down
1 change: 1 addition & 0 deletions RPresto.Rproj
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,5 @@ StripTrailingWhitespace: Yes
BuildType: Package
PackageUseDevtools: Yes
PackageInstallArgs: --no-multiarch --with-keep.source
PackageCheckArgs: --as-cran
PackageRoxygenize: rd,collate,namespace
4 changes: 2 additions & 2 deletions man/Presto.Rd

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

3 changes: 1 addition & 2 deletions man/PrestoConnection-class.Rd

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

11 changes: 5 additions & 6 deletions man/dbCreateTableAs.Rd

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

6 changes: 3 additions & 3 deletions man/dbplyr-sql.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/presto_has_default.Rd

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

6 changes: 3 additions & 3 deletions man/sqlCreateTableAs.Rd

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

Loading