Merge pull request #3 from Oefenweb/fix-typos-cs-errors

Fix typos & CS errors

.lintr

@@ -1 +1,5 @@
-linters: with_defaults(line_length_linter(120), camel_case_linter = NULL)
+linters: linters_with_defaults(
+  line_length_linter(120),
+  cyclocomp_linter = NULL,
+  seq_linter = NULL,
+  object_name_linter = NULL)

DESCRIPTION

@@ -15,6 +15,7 @@ Remotes:
   github::Oefenweb/r-dummy
 Imports:
     DBI (>= 0.5),
-    RMySQL (>= 0.10)
-RoxygenNote: 7.0.2
+    RMySQL (>= 0.10),
+    glue
+RoxygenNote: 7.3.2
 Suggests: testthat

NAMESPACE

@@ -3,3 +3,4 @@
 export(close_connection)
 export(close_connections)
 export(connect)
+export(get_query)

R/close_connection.R

@@ -1,6 +1,6 @@
 #' Disconnects a given database connection.
 #'
-#' @param con A database connection (an object of class MySQLConnection).
+#' @param con A DBIConnection object, as returned by dbConnect().
 #' @return A logical vector of length 1, indicating success or failure.
 #' @export
 close_connection <- function(con) {

R/connect.R

@@ -2,7 +2,7 @@
 #'
 #' @param dbname A database name, for example "oefenweb_nl_app" or "mathsgarden_com_app".
 #' @param default.file A MySQL configuration file, containing login credentials.
-#' @return A database connection (an object of class MySQLConnection).
+#' @return A DBIConnection object, as returned by dbConnect().
 #' @export
 connect <- function(dbname = "oefenweb_nl_app", default.file = path.expand(file.path("~", ".my.cnf"))) {
   return(DBI::dbConnect(RMySQL::MySQL(), dbname = dbname, default.file = default.file))

R/oefenwebDatabase.R

@@ -23,4 +23,4 @@
 #'
 #' @docType package
 #' @name oefenwebDatabase
-NULL
+"_PACKAGE"

R/query.R

@@ -0,0 +1,25 @@
+#' Retrieve results from a query.
+#'
+#'  Suppresses warnings and uses glue_sql for safety.
+#'
+#' @param ... [expressions] Unnamed arguments are taken to be expression string(s) to format.
+#' Multiple inputs are concatenated together before formatting.
+#' @param con A DBIConnection object, as returned by dbConnect().
+#' @param params [list] Containing parameters called in SQL statement with \{params[[i]]\} or \{params[[j]]*\}
+#' @return [data.frame] With as many rows as records were fetched and as many columns as fields in the result set.
+#' @examples
+#' \dontrun{
+#' domain_ids <- 1:4
+#' domain_name <- "Vermenigvuldigen"
+#' query <- "SELECT `name` FROM `domains` WHERE `id` IN ({params[[1]]*}) AND `name` != {params[[2]]}"
+#' params <- list(domain_ids, domain_name)
+#' get_query(query, con = con, params = params)
+#' }
+#' @export
+get_query <- function(..., con = con, params = NULL) {
+  return(
+    suppressWarnings(
+      DBI::dbGetQuery(con, glue::glue_sql(..., .con  = con))
+    )
+  )
+}