R/rocker-package.R

In rocker: Database Interface Class

#' @details
#' \itemize{
#'   \item Description of 'rocker' R6 class: \link[rocker:rocker-R6-class]{rocker-R6-class}
#'   \item Description of S3 functions: \link[rocker:rocker-S3-functions]{rocker-S3-functions}
#'   \item How-to and examples: \link[rocker:rocker-README]{README}
#'   \item Additional information and vignettes: \href{https://cran.r-project.org/package=rocker}{CRAN}
#' }
#' @keywords internal
#' @family rocker
#' @family rocker-S3-functions
#' @aliases rocker-package
"_PACKAGE"

#' README
#'
#' How-to and examples
#' @details
#' Please read me.
#' @includeRmd man/fragments/Installation.Rmd
#' @includeRmd man/fragments/Object.Rmd
#' @includeRmd man/fragments/Packages_Databases.Rmd
#' @includeRmd man/fragments/Connection.Rmd
#' @includeRmd man/fragments/Password.Rmd
#' @includeRmd man/fragments/DBI.Rmd
#' @includeRmd man/fragments/Transaction.Rmd
#' @includeRmd man/fragments/S3.Rmd
#' @name rocker-README
#' @family rocker
#' @family rocker-S3-functions
NULL