diff --git a/DESCRIPTION b/DESCRIPTION index 1a90a99..9e459d0 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -7,9 +7,12 @@ Description: Provides an interface to the 'NoSQL' database 'CouchDB' 'CouchDB' instance, or a remote 'CouchDB' databases such as 'Cloudant'. Documents can be inserted directly from vectors, lists, data.frames, and 'JSON'. Targeted at 'CouchDB' v2 or greater. -Version: 0.4.0 +Version: 0.4.1 Authors@R: c( - person("Eduard", "Szöcs", role = c("aut", "cre"), + person("Yaoxiang", "Li", role = c("aut", "cre"), + email = "liyaoxiang@outlook.com", + comment = c(ORCID="0000-0001-9200-1016")), + person("Eduard", "Szöcs", role = c("aut"), email = "eduardszoecs@gmail.com", comment = c(ORCID="0000-0003-1444-9135")), person("Scott", "Chamberlain", role = c("aut"), @@ -35,7 +38,7 @@ Suggests: testthat, knitr, rmarkdown -RoxygenNote: 7.1.0 +RoxygenNote: 7.2.3 X-schema.org-applicationCategory: Databases X-schema.org-keywords: CouchDB, database, NoSQL, documents X-schema.org-isPartOf: https://ropensci.org diff --git a/R/sofa-package.r b/R/sofa-package.r index 3e1e350..fb84ff5 100644 --- a/R/sofa-package.r +++ b/R/sofa-package.r @@ -21,21 +21,21 @@ #' functionality of this package will work with versions < 2, while #' some may not (mango queries, see [db_query()]). I don't #' plan to support older CouchDB versions per se. -#' +#' #' @section Digits after the decimal: #' If you have any concern about number of digits after the decimal #' in your documents, make sure to look at `digits` in your R options. #' The default value is 7 (see [options] for more informnation). You -#' can set the value you like with e.g., `options(digits = 10)`, and -#' get what `digits` is set to with `getOption("digits")`. -#' -#' Note that in [doc_create()] we convert your document to JSON with +#' can set the value you like with e.g., `options(digits = 10)`, and +#' get what `digits` is set to with `getOption("digits")`. +#' +#' Note that in [doc_create()] we convert your document to JSON with #' `jsonlite::toJSON()` if given as a list, which has a `digits` parameter. -#' We pass `getOption("digits")` to the `digits` parameter in -#' `jsonlite::toJSON()`. -#' +#' We pass `getOption("digits")` to the `digits` parameter in +#' `jsonlite::toJSON()`. +#' #' @section Defunct functions: -#' +#' #' - [attach_get] #' #' @importFrom R6 R6Class @@ -45,6 +45,7 @@ #' @aliases sofa #' @docType package #' @title R client for CouchDB +#' @author Yaoxiang Li \email{liyaoxiang@@outlook.com} #' @author Scott Chamberlain \email{myrmecocystus@@gmail.com} #' @author Eduard Szöcs \email{eduardszoecs@@gmail.com} #' @keywords package diff --git a/man/Cushion.Rd b/man/Cushion.Rd index 015db8f..465e611 100644 --- a/man/Cushion.Rd +++ b/man/Cushion.Rd @@ -106,19 +106,19 @@ db_changes(x, "mymtcars") \section{Methods}{ \subsection{Public methods}{ \itemize{ -\item \href{#method-new}{\code{Cushion$new()}} -\item \href{#method-print}{\code{Cushion$print()}} -\item \href{#method-ping}{\code{Cushion$ping()}} -\item \href{#method-make_url}{\code{Cushion$make_url()}} -\item \href{#method-get_headers}{\code{Cushion$get_headers()}} -\item \href{#method-get_auth}{\code{Cushion$get_auth()}} -\item \href{#method-version}{\code{Cushion$version()}} -\item \href{#method-clone}{\code{Cushion$clone()}} +\item \href{#method-Cushion-new}{\code{Cushion$new()}} +\item \href{#method-Cushion-print}{\code{Cushion$print()}} +\item \href{#method-Cushion-ping}{\code{Cushion$ping()}} +\item \href{#method-Cushion-make_url}{\code{Cushion$make_url()}} +\item \href{#method-Cushion-get_headers}{\code{Cushion$get_headers()}} +\item \href{#method-Cushion-get_auth}{\code{Cushion$get_auth()}} +\item \href{#method-Cushion-version}{\code{Cushion$version()}} +\item \href{#method-Cushion-clone}{\code{Cushion$clone()}} } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-new}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-Cushion-new}{}}} \subsection{Method \code{new()}}{ Create a new \code{Cushion} object \subsection{Usage}{ @@ -154,8 +154,8 @@ A new \code{Cushion} object } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-print}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-Cushion-print}{}}} \subsection{Method \code{print()}}{ print method for \code{Cushion} \subsection{Usage}{ @@ -173,8 +173,8 @@ print method for \code{Cushion} } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-ping}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-Cushion-ping}{}}} \subsection{Method \code{ping()}}{ Ping the CouchDB server \subsection{Usage}{ @@ -192,8 +192,8 @@ Ping the CouchDB server } } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-make_url}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-Cushion-make_url}{}}} \subsection{Method \code{make_url()}}{ Construct full base URL from the pieces in the connection object @@ -203,8 +203,8 @@ connection object } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-get_headers}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-Cushion-get_headers}{}}} \subsection{Method \code{get_headers()}}{ Get list of headers that will be sent with each request @@ -214,8 +214,8 @@ each request } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-get_auth}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-Cushion-get_auth}{}}} \subsection{Method \code{get_auth()}}{ Get list of auth values, user and pwd \subsection{Usage}{ @@ -224,8 +224,8 @@ Get list of auth values, user and pwd } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-version}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-Cushion-version}{}}} \subsection{Method \code{version()}}{ Get the CouchDB version as a numeric \subsection{Usage}{ @@ -234,8 +234,8 @@ Get the CouchDB version as a numeric } \if{html}{\out{
}} -\if{html}{\out{}} -\if{latex}{\out{\hypertarget{method-clone}{}}} +\if{html}{\out{}} +\if{latex}{\out{\hypertarget{method-Cushion-clone}{}}} \subsection{Method \code{clone()}}{ The objects of this class are cloneable with this method. \subsection{Usage}{ diff --git a/man/sofa-package.Rd b/man/sofa-package.Rd index b31fbd4..84b6a87 100644 --- a/man/sofa-package.Rd +++ b/man/sofa-package.Rd @@ -57,5 +57,7 @@ We pass \code{getOption("digits")} to the \code{digits} parameter in \author{ Scott Chamberlain \email{myrmecocystus@gmail.com} + +Eduard Szöcs \email{eduardszoecs@gmail.com} } \keyword{package}