Regenerating documentation

OHDSI · Feb 11, 2022 · 8963235 · 8963235
1 parent b354c75
commit 8963235
Show file tree

Hide file tree

Showing 21 changed files with 47 additions and 23 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -2,7 +2,7 @@ Package: DatabaseConnector
 Type: Package
 Title: Connecting to Various Database Platforms
 Version: 5.0.2
-Date: 2022-02-07
+Date: 2022-02-11
 Authors@R: c(
     person("Martijn", "Schuemie", email = "[email protected]", role = c("aut", "cre")),
     person("Marc", "Suchard", role = c("aut")),

diff --git a/NAMESPACE b/NAMESPACE
@@ -78,6 +78,7 @@ importFrom(utils,download.file)
 importFrom(utils,install.packages)
 importFrom(utils,menu)
 importFrom(utils,object.size)
+importFrom(utils,packageVersion)
 importFrom(utils,read.csv)
 importFrom(utils,sessionInfo)
 importFrom(utils,setTxtProgressBar)

diff --git a/R/DatabaseConnector.R b/R/DatabaseConnector.R
@@ -19,7 +19,7 @@
 #' @keywords internal
 "_PACKAGE"
 
-#' @importFrom utils sessionInfo setTxtProgressBar txtProgressBar object.size write.csv write.table read.csv install.packages menu download.file unzip
+#' @importFrom utils sessionInfo setTxtProgressBar txtProgressBar object.size write.csv write.table read.csv install.packages menu download.file unzip packageVersion
 #' @importFrom bit64 integer64
 #' @importFrom rlang warn abort inform
 NULL

diff --git a/README.md b/README.md
@@ -8,8 +8,10 @@ DatabaseConnector
 
 DatabaseConnector is part of [HADES](https://ohdsi.github.io/Hades/).
 
+
 Introduction
 ============
+
 This R package provides function for connecting to various DBMSs. Together with the `SqlRender` package, the main goal of `DatabaseConnector` is to provide a uniform interface across database platforms: the same code should run and produce equivalent results, regardless of the database back end.
 
 Features
@@ -34,8 +36,10 @@ Features
 - Supports the DBI interface
 - Integrates with RStudio's Connections tab
 
+
 Examples
 ========
+
 ```r
 connectionDetails <- createConnectionDetails(dbms="postgresql", 
                                              server="localhost",
@@ -47,14 +51,19 @@ querySql(conn,"SELECT COUNT(*) FROM person")
 disconnect(conn)
 ```
 
+
 Technology
 ============
+
 DatabaseConnector is an R package using Java's JDBC drivers. 
 
+
 System Requirements
 ===================
+
 Running the package requires R with the package rJava installed. Also requires Java 1.8 or higher.
 
+
 Installation
 ============
 
@@ -66,9 +75,9 @@ Installation
 install.packages("DatabaseConnector")
 ```
 
-3. Download the database drivers as described [here](http://ohdsi.github.io/DatabaseConnector/articles/Connecting.html#obtaining-drivers)
+3. Download the database drivers as described [here](http://ohdsi.github.io/DatabaseConnector/articles/Connecting.html#obtaining-drivers).
 
-4. (Optionally) To use Windows Authentication for SQL Server, download the authentication DDL file as described  [here](http://ohdsi.github.io/DatabaseConnector/reference/connect.html#windows-authentication-for-sql-server-1)
+4. (Optionally) To use Windows Authentication for SQL Server, download the authentication DDL file as described  [here](http://ohdsi.github.io/DatabaseConnector/reference/connect.html#windows-authentication-for-sql-server-1).
 
 User Documentation
 ==================
@@ -80,27 +89,38 @@ PDF versions of the documentation are also available:
 * Vignette: [Querying a database](https://github.com/OHDSI/DatabaseConnector/raw/main/inst/doc/Querying.pdf)
 * Package manual: [DatabaseConnector manual](https://raw.githubusercontent.com/OHDSI/DatabaseConnector/main/extras/DatabaseConnector.pdf) 
 
+
 Support
 =======
+
 * Developer questions/comments/feedback: <a href="http://forums.ohdsi.org/c/developers">OHDSI Forum</a>
 * We use the <a href="https://github.com/OHDSI/DatabaseConnector/issues">GitHub issue tracker</a> for all bugs/issues/enhancements
 
+
 Contributing
 ============
+
 Read [here](https://ohdsi.github.io/Hades/contribute.html) how you can contribute to this package.
 
+
 License
 =======
+
 DatabaseConnector is licensed under Apache License 2.0. The JDBC drivers [fall under their own respective licenses](https://raw.githubusercontent.com/OHDSI/DatabaseConnector/main/inst/COPYRIGHTS).
 
+
 Development
 ===========
+
 DatabaseConnector is being developed in R Studio.
 
+
 ### Development status
 
 Stable. The code is actively being used in several projects.
 
-# Acknowledgements
-- This project is supported in part through the National Science Foundation grant IIS 1251151.
 
+Acknowledgements
+================
+
+- This project is supported in part through the National Science Foundation grant IIS 1251151.
diff --git a/cran-comments.md b/cran-comments.md
@@ -1,4 +1,4 @@
-This update includes 7 changes and 2 bugfixes since 5.0.0 (see NEWS.md)
+This update includes 8 changes and 2 bugfixes since 5.0.0 (see NEWS.md)
 
 ---
 

diff --git a/docs/articles/Connecting.html b/docs/articles/Connecting.html
diff --git a/docs/articles/Querying.html b/docs/articles/Querying.html
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/news/index.html b/docs/news/index.html
diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml
@@ -4,5 +4,5 @@ pkgdown_sha: ~
 articles:
   Connecting: Connecting.html
   Querying: Querying.html
-last_built: 2022-02-09T07:58Z
+last_built: 2022-02-11T05:36Z
 
diff --git a/docs/reference/dbAppendTable-DatabaseConnectorConnection-character-data.frame-method.html b/docs/reference/dbAppendTable-DatabaseConnectorConnection-character-data.frame-method.html
diff --git a/docs/reference/dbListTables-DatabaseConnectorConnection-method.html b/docs/reference/dbListTables-DatabaseConnectorConnection-method.html
diff --git a/docs/reference/dbReadTable-DatabaseConnectorConnection-character-method.html b/docs/reference/dbReadTable-DatabaseConnectorConnection-character-method.html
diff --git a/extras/DatabaseConnector.pdf b/extras/DatabaseConnector.pdf
diff --git a/extras/PackageMaintenance.R b/extras/PackageMaintenance.R
@@ -49,9 +49,9 @@ rmarkdown::render("vignettes/Querying.Rmd",
                                           number_sections = TRUE))
 unlink("inst/doc/Querying.tex")
 
-# DBI 1.1.2 is causing an error when builing the package website, so downgrading to 1.1.0 for now:
+# DBI 1.1.2 is causing an error when builing the package website, so downgrading to 1.1.1 for now:
 require(devtools)
-install_version("DBI", version = "1.1.0", repos = "http://cran.us.r-project.org")
+install_version("DBI", version = "1.1.1", repos = "http://cran.us.r-project.org")
 roxygen2::roxygenize('.', roclets = c('rd', 'collate', 'namespace'))
 
 pkgdown::build_site()

diff --git a/inst/doc/Connecting.pdf b/inst/doc/Connecting.pdf
diff --git a/inst/doc/Querying.pdf b/inst/doc/Querying.pdf
diff --git a/man/dbAppendTable-DatabaseConnectorConnection-character-data.frame-method.Rd b/man/dbAppendTable-DatabaseConnectorConnection-character-data.frame-method.Rd
diff --git a/man/dbExistsTable-DatabaseConnectorConnection-character-method.Rd b/man/dbExistsTable-DatabaseConnectorConnection-character-method.Rd
diff --git a/man/dbListTables-DatabaseConnectorConnection-method.Rd b/man/dbListTables-DatabaseConnectorConnection-method.Rd
diff --git a/man/dbReadTable-DatabaseConnectorConnection-character-method.Rd b/man/dbReadTable-DatabaseConnectorConnection-character-method.Rd