diff --git a/NAMESPACE b/NAMESPACE index 98336e9..ad32cd7 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -5,8 +5,6 @@ export(createRSQL) export(getMtcarsdbPath) export(getPackageDir) export(parse_where_clause) -export(sql_retrieve) -export(sql_retrieve_insert) import(DBI) import(R6) import(lgr) diff --git a/R/sql-lib.R b/R/sql-lib.R index 21b13fc..23402dd 100644 --- a/R/sql-lib.R +++ b/R/sql-lib.R @@ -13,6 +13,7 @@ #' @description #' This class is intended to simplify SQL commands. #' @examples +#' library(RSQL) #' db.name <- getMtcarsdbPath(copy = TRUE) #' rsql <- createRSQL(drv = RSQLite::SQLite(), dbname = db.name) #' where_values_df <- data.frame(carb = 8, stringsAsFactors = FALSE) @@ -35,7 +36,7 @@ #' where_values = where_values_df) #' mtcars.observed <- rsql$execute_select(select_sql) #' mtcars.observed -#' å +#' #' @export #' @importFrom R6 R6Class RSQL.class <- R6::R6Class("RSQL", public = list( @@ -821,7 +822,6 @@ df_verify <- function(dataframe, columns) { #' @param fields The fields (Not used. Included for compatibility) #' @param values The values (Not used. Included for compatibility) #' @param dbconn The database connection -#' @export sql_retrieve <- function(table, fields_uk = names(values_uk), values_uk, fields = names(values), values = NULL, field_id = "id", dbconn = NULL) { @@ -853,7 +853,6 @@ sql_retrieve <- function(table, fields_uk = names(values_uk), values_uk, #' @param values The values #' @param field_id The field of the serial id #' @param dbconn The database connection -#' @export sql_retrieve_insert <- function(table, fields_uk = names(values_uk), values_uk, fields = names(values), values = NULL, field_id = "id", dbconn = NULL) { @@ -1033,7 +1032,7 @@ parse_where_clause <- function(where_clause_list = c()) { #' Gets the path of package data. #' @export getPackageDir <- function(){ - home.dir <- find.package("rsql", lib.loc = NULL, quiet = TRUE) + home.dir <- find.package("RSQL", lib.loc = NULL, quiet = TRUE) data.subdir <- file.path("inst", "extdata") if (!dir.exists(file.path(home.dir, data.subdir))) data.subdir <- "extdata" diff --git a/R/zzz.R b/R/zzz.R index dc2e6cd..6e52e3c 100644 --- a/R/zzz.R +++ b/R/zzz.R @@ -3,7 +3,7 @@ #' A package to work with SQL datasources in a simple manner #' #' @docType package -#' @name rsql +#' @name RSQL #' @import R6 lgr DBI #' @importFrom utils str #' @author Alejandro Baranek , Leonardo Javier Belen diff --git a/man/RSQL.class.Rd b/man/RSQL.class.Rd index 0834689..346b1b4 100644 --- a/man/RSQL.class.Rd +++ b/man/RSQL.class.Rd @@ -7,6 +7,7 @@ This class is intended to simplify SQL commands. } \examples{ +library(RSQL) db.name <- getMtcarsdbPath(copy = TRUE) rsql <- createRSQL(drv = RSQLite::SQLite(), dbname = db.name) where_values_df <- data.frame(carb = 8, stringsAsFactors = FALSE) @@ -29,7 +30,7 @@ select_sql <- rsql$gen_select( where_values = where_values_df) mtcars.observed <- rsql$execute_select(select_sql) mtcars.observed -å + } \section{Public fields}{ \if{html}{\out{
}} diff --git a/man/rsql.Rd b/man/rsql.Rd index c5bacdb..3b486e2 100644 --- a/man/rsql.Rd +++ b/man/rsql.Rd @@ -1,8 +1,8 @@ % Generated by roxygen2: do not edit by hand % Please edit documentation in R/zzz.R \docType{package} -\name{rsql} -\alias{rsql} +\name{RSQL} +\alias{RSQL} \alias{.onLoad} \title{rsql} \usage{ diff --git a/tests/testthat.R b/tests/testthat.R index 4033c4b..7c2b107 100644 --- a/tests/testthat.R +++ b/tests/testthat.R @@ -1,8 +1,9 @@ library(testthat) library(DBI) library(RSQLite) -library(rsql) +library(RSQL) library(lgr) +library(dplyr) log.levels <- lgr::get_log_levels() @@ -10,4 +11,4 @@ lgr$set_threshold(log.levels["debug"]) -test_check("rsql") +test_check("RSQL") diff --git a/tests/testthat/test_sql_lib.R b/tests/testthat/test_sql_lib.R index 1a25ebe..6f04592 100644 --- a/tests/testthat/test_sql_lib.R +++ b/tests/testthat/test_sql_lib.R @@ -1,5 +1,3 @@ -# TODO remove from here -library(dplyr) db.name <- getMtcarsdbPath() rsql <- createRSQL(drv = RSQLite::SQLite(), dbname = db.name) diff --git a/vignettes/rsql.Rmd b/vignettes/rsql.Rmd index 7326bc9..9bbfd03 100644 --- a/vignettes/rsql.Rmd +++ b/vignettes/rsql.Rmd @@ -13,14 +13,14 @@ In order to use rsql, a RSQL object has to be initialized, indicating all inform ``` library(RSQLite) -sql <- rsql(drv=RSQLite::SQLite(), dbname = "mtcars") +sql <- createRSQL(drv=RSQLite::SQLite(), dbname = "mtcars") ``` On success, it is possible to use the object to produce queries and execute them to retrieve information. Returned query sets can be in data.frame format for easy integration with R scripts. ``` library(RSQLite) -sql <- rsql(drv=RSQLite::SQLite(), dbname = "mtcars") +sql <- createRSQL(drv=RSQLite::SQLite(), dbname = "mtcars") query.sql <- sql$generate_select(c("mpg","cyl","disp","hp","drat","wt","qsec","vs","am","gear","carb"), "mtcars") mtcars.df <- sql$execute_select(query.sql) @@ -30,7 +30,7 @@ Also, rsql allows to insert or delete records as easily. ``` library(RSQLite) -sql <- rsql(drv=RSQLite::SQLite(), dbname = "mtcars") +sql <- createRSQL(drv=RSQLite::SQLite(), dbname = "mtcars") insert.fields <- c("mpg","cyl","disp","hp","drat","wt","qsec","vs","am","gear","carb") insert.data <- data.frame(1,2,3,4,5,6,7,8,9,10,11) insert.sql <- sql$generate_insert("mtcars",insert.fields, @@ -44,6 +44,6 @@ Finally, once the connection is not longer needed, it has to be expressly discon ``` library(RSQLite) -sql <- rsql(drv=RSQLite::SQLite(), dbname = "mtcars") +sql <- createRSQL(drv=RSQLite::SQLite(), dbname = "mtcars") sql$disconnect() ```