test: Fix checks without suggested packages

r-dbi · Nov 8, 2023 · bec2cde · bec2cde
1 parent 7d6454e
commit bec2cde
Show file tree

Hide file tree

Showing 74 changed files with 119 additions and 41 deletions.
diff --git a/R/01-DBIObject.R b/R/01-DBIObject.R
@@ -31,7 +31,7 @@ NULL
 #'
 #' @docType class
 #' @family DBI classes
-#' @examples
+#' @examplesIf requireNamespace("RSQLite", quietly = TRUE)
 #' drv <- RSQLite::SQLite()
 #' con <- dbConnect(drv)
 #'

diff --git a/R/03-DBIConnection.R b/R/03-DBIConnection.R
@@ -12,7 +12,7 @@
 #' @name DBIConnection-class
 #' @family DBI classes
 #' @family DBIConnection generics
-#' @examples
+#' @examplesIf requireNamespace("RSQLite", quietly = TRUE)
 #' con <- dbConnect(RSQLite::SQLite(), ":memory:")
 #' con
 #' dbDisconnect(con)

diff --git a/R/11-dbAppendTable.R b/R/11-dbAppendTable.R
@@ -28,7 +28,7 @@
 #'
 #' @family DBIConnection generics
 #' @export
-#' @examples
+#' @examplesIf requireNamespace("RSQLite", quietly = TRUE)
 #' con <- dbConnect(RSQLite::SQLite(), ":memory:")
 #' dbCreateTable(con, "iris", iris)
 #' dbAppendTable(con, "iris", iris)

diff --git a/R/12-dbCreateTable.R b/R/12-dbCreateTable.R
@@ -27,7 +27,7 @@
 #'
 #' @family DBIConnection generics
 #' @export
-#' @examples
+#' @examplesIf requireNamespace("RSQLite", quietly = TRUE)
 #' con <- dbConnect(RSQLite::SQLite(), ":memory:")
 #' dbCreateTable(con, "iris", iris)
 #' dbReadTable(con, "iris")

diff --git a/R/13-dbWriteTable.R b/R/13-dbWriteTable.R
@@ -28,7 +28,7 @@
 #'   For `dbWriteTableArrow()`, an object coercible to an Arrow RecordBatchReader.
 #' @family DBIConnection generics
 #' @export
-#' @examples
+#' @examplesIf requireNamespace("RSQLite", quietly = TRUE)
 #' con <- dbConnect(RSQLite::SQLite(), ":memory:")
 #'
 #' dbWriteTable(con, "mtcars", mtcars[1:5, ])

diff --git a/R/DBI-package.R b/R/DBI-package.R
@@ -8,7 +8,7 @@
 #' @inheritSection DBItest::spec_compliance_methods DBI classes and methods
 #' @inheritSection DBItest::spec_driver_constructor Construction of the DBIDriver object
 #'
-#' @examples
+#' @examplesIf requireNamespace("RSQLite", quietly = TRUE)
 #' RSQLite::SQLite()
 #' @seealso
 #'   Important generics: [dbConnect()], [dbGetQuery()],

diff --git a/R/DBIConnector.R b/R/DBIConnector.R
@@ -25,7 +25,7 @@ NULL
 #' @family DBI classes
 #' @family DBIConnector generics
 #' @export
-#' @examples
+#' @examplesIf requireNamespace("RSQLite", quietly = TRUE)
 #' # Create a connector:
 #' cnr <- new("DBIConnector",
 #'   .drv = RSQLite::SQLite(),

diff --git a/R/dbBind.R b/R/dbBind.R
@@ -104,7 +104,7 @@
 #' @family data retrieval generics
 #' @family command execution generics
 #' @export
-#' @examples
+#' @examplesIf requireNamespace("RSQLite", quietly = TRUE)
 #' con <- dbConnect(RSQLite::SQLite(), ":memory:")
 #'
 #' dbWriteTable(con, "iris", iris)

diff --git a/R/dbCanConnect.R b/R/dbCanConnect.R
@@ -14,7 +14,7 @@
 #' @inheritParams dbConnect
 #' @family DBIDriver generics
 #' @export
-#' @examples
+#' @examplesIf requireNamespace("RSQLite", quietly = TRUE)
 #' # SQLite only needs a path to the database. (Here, ":memory:" is a special
 #' # path that creates an in-memory database.) Other database drivers
 #' # will require more details (like user, password, host, port, etc.)

diff --git a/R/dbClearResult.R b/R/dbClearResult.R
@@ -20,7 +20,7 @@
 #' @family data retrieval generics
 #' @family command execution generics
 #' @export
-#' @examples
+#' @examplesIf requireNamespace("RSQLite", quietly = TRUE)
 #' con <- dbConnect(RSQLite::SQLite(), ":memory:")
 #'
 #' rs <- dbSendQuery(con, "SELECT 1")

diff --git a/R/dbColumnInfo.R b/R/dbColumnInfo.R
@@ -18,7 +18,7 @@
 #'
 #' @family DBIResult generics
 #' @export
-#' @examples
+#' @examplesIf requireNamespace("RSQLite", quietly = TRUE)
 #' con <- dbConnect(RSQLite::SQLite(), ":memory:")
 #'
 #' rs <- dbSendQuery(con, "SELECT 1 AS a, 2 AS b")

diff --git a/R/dbConnect.R b/R/dbConnect.R
@@ -24,7 +24,7 @@
 #' @family DBIDriver generics
 #' @family DBIConnector generics
 #' @export
-#' @examples
+#' @examplesIf requireNamespace("RSQLite", quietly = TRUE)
 #' # SQLite only needs a path to the database. (Here, ":memory:" is a special
 #' # path that creates an in-memory database.) Other database drivers
 #' # will require more details (like user, password, host, port, etc.)

diff --git a/R/dbDataType.R b/R/dbDataType.R
@@ -45,6 +45,7 @@
 #' dbDataType(ANSI(), I(3))
 #'
 #' dbDataType(ANSI(), iris)
+#' @examplesIf requireNamespace("RSQLite", quietly = TRUE)
 #'
 #' con <- dbConnect(RSQLite::SQLite(), ":memory:")
 #'

diff --git a/R/dbDisconnect.R b/R/dbDisconnect.R
@@ -12,7 +12,7 @@
 #' @inheritParams dbGetQuery
 #' @family DBIConnection generics
 #' @export
-#' @examples
+#' @examplesIf requireNamespace("RSQLite", quietly = TRUE)
 #' con <- dbConnect(RSQLite::SQLite(), ":memory:")
 #' dbDisconnect(con)
 setGeneric("dbDisconnect",

diff --git a/R/dbDriver.R b/R/dbDriver.R
@@ -31,7 +31,7 @@
 #' @family DBIDriver generics
 #' @export
 #' @keywords internal
-#' @examples
+#' @examplesIf requireNamespace("RSQLite", quietly = TRUE)
 #' # Create a RSQLite driver with a string
 #' d <- dbDriver("SQLite")
 #' d

diff --git a/R/dbExecute.R b/R/dbExecute.R
@@ -33,7 +33,7 @@
 #' @family command execution generics
 #' @seealso For queries: [dbSendQuery()] and [dbGetQuery()].
 #' @export
-#' @examples
+#' @examplesIf requireNamespace("RSQLite", quietly = TRUE)
 #' con <- dbConnect(RSQLite::SQLite(), ":memory:")
 #'
 #' dbWriteTable(con, "cars", head(cars, 3))

diff --git a/R/dbExistsTable.R b/R/dbExistsTable.R
@@ -12,7 +12,7 @@
 #' @inheritParams dbReadTable
 #' @family DBIConnection generics
 #' @export
-#' @examples
+#' @examplesIf requireNamespace("RSQLite", quietly = TRUE)
 #' con <- dbConnect(RSQLite::SQLite(), ":memory:")
 #'
 #' dbExistsTable(con, "iris")

diff --git a/R/dbFetch.R b/R/dbFetch.R
@@ -29,7 +29,7 @@
 #'   finish retrieving the records you want.
 #' @family DBIResult generics
 #' @family data retrieval generics
-#' @examples
+#' @examplesIf requireNamespace("RSQLite", quietly = TRUE)
 #' con <- dbConnect(RSQLite::SQLite(), ":memory:")
 #'
 #' dbWriteTable(con, "mtcars", mtcars)

diff --git a/R/dbGetConnectArgs.R b/R/dbGetConnectArgs.R
@@ -13,7 +13,7 @@
 #'   instead of evaluating them.
 #' @param ... Other arguments passed on to methods. Not otherwise used.
 #' @family DBIConnector generics
-#' @examples
+#' @examplesIf requireNamespace("RSQLite", quietly = TRUE)
 #' cnr <- new("DBIConnector",
 #'   .drv = RSQLite::SQLite(),
 #'   .conn_args = list(dbname = ":memory:", password = function() "supersecret")

diff --git a/R/dbGetQuery.R b/R/dbGetQuery.R
@@ -41,7 +41,7 @@
 #' @family data retrieval generics
 #' @seealso For updates: [dbSendStatement()] and [dbExecute()].
 #' @export
-#' @examples
+#' @examplesIf requireNamespace("RSQLite", quietly = TRUE)
 #' con <- dbConnect(RSQLite::SQLite(), ":memory:")
 #'
 #' dbWriteTable(con, "mtcars", mtcars)

diff --git a/R/dbGetQueryArrow.R b/R/dbGetQueryArrow.R
@@ -1,5 +1,5 @@
 #' @export
-#' @examplesIf packageVersion("nanoarrow") >= "0.1.0.2"
+#' @examplesIf requireNamespace("RSQLite", quietly = TRUE) && requireNamespace("nanoarrow", quietly = TRUE) && packageVersion("nanoarrow") >= "0.1.0.2"
 #' # Retrieve data as arrow table
 #' con <- dbConnect(RSQLite::SQLite(), ":memory:")
 #'

diff --git a/R/dbGetRowCount.R b/R/dbGetRowCount.R
@@ -12,7 +12,7 @@
 #' @inheritParams dbClearResult
 #' @family DBIResult generics
 #' @export
-#' @examples
+#' @examplesIf requireNamespace("RSQLite", quietly = TRUE)
 #' con <- dbConnect(RSQLite::SQLite(), ":memory:")
 #'
 #' dbWriteTable(con, "mtcars", mtcars)

diff --git a/R/dbGetRowsAffected.R b/R/dbGetRowsAffected.R
@@ -15,7 +15,7 @@
 #' @family DBIResult generics
 #' @family command execution generics
 #' @export
-#' @examples
+#' @examplesIf requireNamespace("RSQLite", quietly = TRUE)
 #' con <- dbConnect(RSQLite::SQLite(), ":memory:")
 #'
 #' dbWriteTable(con, "mtcars", mtcars)

diff --git a/R/dbGetStatement.R b/R/dbGetStatement.R
@@ -12,7 +12,7 @@
 #' @inheritParams dbClearResult
 #' @family DBIResult generics
 #' @export
-#' @examples
+#' @examplesIf requireNamespace("RSQLite", quietly = TRUE)
 #' con <- dbConnect(RSQLite::SQLite(), ":memory:")
 #'
 #' dbWriteTable(con, "mtcars", mtcars)

diff --git a/R/dbHasCompleted.R b/R/dbHasCompleted.R
@@ -17,7 +17,7 @@
 #' @family DBIResult generics
 #' @family data retrieval generics
 #' @export
-#' @examples
+#' @examplesIf requireNamespace("RSQLite", quietly = TRUE)
 #' con <- dbConnect(RSQLite::SQLite(), ":memory:")
 #'
 #' dbWriteTable(con, "mtcars", mtcars)

diff --git a/R/dbIsValid.R b/R/dbIsValid.R
@@ -13,7 +13,7 @@
 #' @family DBIConnection generics
 #' @family DBIResult generics
 #' @export
-#' @examples
+#' @examplesIf requireNamespace("RSQLite", quietly = TRUE)
 #' dbIsValid(RSQLite::SQLite())
 #'
 #' con <- dbConnect(RSQLite::SQLite(), ":memory:")

diff --git a/R/dbListFields.R b/R/dbListFields.R
@@ -14,7 +14,7 @@
 #' @family DBIConnection generics
 #' @seealso [dbColumnInfo()] to get the type of the fields.
 #' @export
-#' @examples
+#' @examplesIf requireNamespace("RSQLite", quietly = TRUE)
 #' con <- dbConnect(RSQLite::SQLite(), ":memory:")
 #'
 #' dbWriteTable(con, "mtcars", mtcars)

diff --git a/R/dbListObjects.R b/R/dbListObjects.R
@@ -23,7 +23,7 @@
 #'   If given the method will return all objects accessible through this prefix.
 #' @family DBIConnection generics
 #' @export
-#' @examples
+#' @examplesIf requireNamespace("RSQLite", quietly = TRUE)
 #' con <- dbConnect(RSQLite::SQLite(), ":memory:")
 #'
 #' dbListObjects(con)

diff --git a/R/dbListTables.R b/R/dbListTables.R
@@ -14,7 +14,7 @@
 #' @inheritParams dbGetQuery
 #' @family DBIConnection generics
 #' @export
-#' @examples
+#' @examplesIf requireNamespace("RSQLite", quietly = TRUE)
 #' con <- dbConnect(RSQLite::SQLite(), ":memory:")
 #'
 #' dbListTables(con)

diff --git a/R/dbReadTable.R b/R/dbReadTable.R
@@ -22,7 +22,7 @@
 #'     given verbatim, e.g. `SQL('"my_schema"."table_name"')`
 #' @family DBIConnection generics
 #' @export
-#' @examples
+#' @examplesIf requireNamespace("RSQLite", quietly = TRUE)
 #' con <- dbConnect(RSQLite::SQLite(), ":memory:")
 #'
 #' dbWriteTable(con, "mtcars", mtcars[1:10, ])

diff --git a/R/dbReadTableArrow.R b/R/dbReadTableArrow.R
@@ -1,6 +1,6 @@
 #' @rdname dbReadTable
 #' @export
-#' @examplesIf packageVersion("nanoarrow") >= "0.1.0.2"
+#' @examplesIf requireNamespace("RSQLite", quietly = TRUE) && requireNamespace("nanoarrow", quietly = TRUE) && packageVersion("nanoarrow") >= "0.1.0.2"
 #' # Read data as Arrow table
 #' con <- dbConnect(RSQLite::SQLite(), ":memory:")
 #'

diff --git a/R/dbRemoveTable.R b/R/dbRemoveTable.R
@@ -14,7 +14,7 @@
 #' @inheritParams dbReadTable
 #' @family DBIConnection generics
 #' @export
-#' @examples
+#' @examplesIf requireNamespace("RSQLite", quietly = TRUE)
 #' con <- dbConnect(RSQLite::SQLite(), ":memory:")
 #'
 #' dbExistsTable(con, "iris")

diff --git a/R/dbSendQuery.R b/R/dbSendQuery.R
@@ -36,7 +36,7 @@
 #' @family DBIConnection generics
 #' @family data retrieval generics
 #' @seealso For updates: [dbSendStatement()] and [dbExecute()].
-#' @examples
+#' @examplesIf requireNamespace("RSQLite", quietly = TRUE)
 #' con <- dbConnect(RSQLite::SQLite(), ":memory:")
 #'
 #' dbWriteTable(con, "mtcars", mtcars)

diff --git a/R/dbSendQueryArrow.R b/R/dbSendQueryArrow.R
@@ -1,5 +1,5 @@
 #' @rdname dbSendQuery
-#' @examplesIf packageVersion("nanoarrow") >= "0.1.0.2"
+#' @examplesIf requireNamespace("RSQLite", quietly = TRUE) && requireNamespace("nanoarrow", quietly = TRUE) && packageVersion("nanoarrow") >= "0.1.0.2"
 #' # Retrieve data as arrow table
 #' con <- dbConnect(RSQLite::SQLite(), ":memory:")
 #'

diff --git a/R/dbSendStatement.R b/R/dbSendStatement.R
@@ -30,7 +30,7 @@
 #' @family command execution generics
 #'
 #' @seealso For queries: [dbSendQuery()] and [dbGetQuery()].
-#' @examples
+#' @examplesIf requireNamespace("RSQLite", quietly = TRUE)
 #' con <- dbConnect(RSQLite::SQLite(), ":memory:")
 #'
 #' dbWriteTable(con, "cars", head(cars, 3))

diff --git a/R/dbWithTransaction.R b/R/dbWithTransaction.R
@@ -26,7 +26,7 @@
 #' @param code An arbitrary block of R code.
 #'
 #' @export
-#' @examples
+#' @examplesIf requireNamespace("RSQLite", quietly = TRUE)
 #' con <- dbConnect(RSQLite::SQLite(), ":memory:")
 #'
 #' dbWriteTable(con, "cash", data.frame(amount = 100))

diff --git a/R/sqlData.R b/R/sqlData.R
@@ -21,7 +21,7 @@
 #' @templateVar method_name sqlData
 #'
 #' @export
-#' @examples
+#' @examplesIf requireNamespace("RSQLite", quietly = TRUE)
 #' con <- dbConnect(RSQLite::SQLite(), ":memory:")
 #'
 #' sqlData(con, head(iris))

diff --git a/R/transactions.R b/R/transactions.R
@@ -20,7 +20,7 @@
 #'
 #' @inheritParams dbGetQuery
 #' @seealso Self-contained transactions: [dbWithTransaction()]
-#' @examples
+#' @examplesIf requireNamespace("RSQLite", quietly = TRUE)
 #' con <- dbConnect(RSQLite::SQLite(), ":memory:")
 #'
 #' dbWriteTable(con, "cash", data.frame(amount = 100))

diff --git a/man/DBI-package.Rd b/man/DBI-package.Rd
diff --git a/man/DBIConnection-class.Rd b/man/DBIConnection-class.Rd
diff --git a/man/DBIConnector-class.Rd b/man/DBIConnector-class.Rd
diff --git a/man/DBIObject-class.Rd b/man/DBIObject-class.Rd