diff --git a/R/dbtools.R b/R/dbtools.R new file mode 100644 index 0000000..7337dc0 --- /dev/null +++ b/R/dbtools.R @@ -0,0 +1,22 @@ +#' dbtools: A package for accessing AWS Athena from the Analytical Platform. +#' +#' @section About: +#' The dbtools package is used to run SQL queries configured for the +#' Analytical Platform. This package is a reticulated +#' wrapper around the Python library pydbtools +#' which uses AWS Wrangler's Athena module but adds additional functionality +#' (like Jinja templating, creating temporary tables) and alters some configuration +#' to our specification. +#' +#' Alternatively you might want to use +#' Rdbtools, which has the +#' advantages of being R-native, so no messing with `reticulate` and Python, and +#' supporting `dbplyr`. Please note the caveat about support, though. +#' +#' @seealso \url{https://github.com/moj-analytical-services/pydbtools} +#' @seealso \url{https://github.com/moj-analytical-services/Rdbtools} +#' +#' @docType package +#' @name dbtools +NULL +#> NULL diff --git a/README.md b/README.md index 6be72c2..9a0ea67 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Platform should refer to the [Legacy](#legacy) section below. ## About A package that is used to run SQL queries configured for the -Analytical Platform. This packages is a [reticulated](https://rstudio.github.io/reticulate/) +Analytical Platform. This package is a [reticulated](https://rstudio.github.io/reticulate/) wrapper around [pydbtools](https://github.com/moj-analytical-services/pydbtools) which uses AWS Wrangler's Athena module but adds additional functionality (like Jinja templating, creating temporary tables) and alters some configuration diff --git a/man/dbtools.Rd b/man/dbtools.Rd new file mode 100644 index 0000000..c45cab0 --- /dev/null +++ b/man/dbtools.Rd @@ -0,0 +1,26 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/dbtools.R +\docType{package} +\name{dbtools} +\alias{dbtools} +\title{dbtools: A package for accessing AWS Athena from the Analytical Platform.} +\section{About}{ + +The dbtools package is used to run SQL queries configured for the +Analytical Platform. This package is a reticulated +wrapper around the Python library pydbtools +which uses AWS Wrangler's Athena module but adds additional functionality +(like Jinja templating, creating temporary tables) and alters some configuration +to our specification. + +Alternatively you might want to use +Rdbtools, which has the +advantages of being R-native, so no messing with `reticulate` and Python, and +supporting `dbplyr`. Please note the caveat about support, though. +} + +\seealso{ +\url{https://github.com/moj-analytical-services/pydbtools} + +\url{https://github.com/moj-analytical-services/Rdbtools} +}