From 436bcd919ad7dccb5a075055225513a56276433e Mon Sep 17 00:00:00 2001 From: Ralf Herold Date: Sun, 21 Jul 2019 17:01:14 +0200 Subject: [PATCH] adding / correcting documentation for mongo --- man/docdb_create.Rd | 4 ++-- man/docdb_delete.Rd | 4 ++-- man/docdb_get.Rd | 4 ++-- man/docdb_query.Rd | 4 ++-- man/docdb_update.Rd | 2 +- 5 files changed, 9 insertions(+), 9 deletions(-) diff --git a/man/docdb_create.Rd b/man/docdb_create.Rd index 0819164..a09ad66 100644 --- a/man/docdb_create.Rd +++ b/man/docdb_create.Rd @@ -9,7 +9,7 @@ docdb_create(src, key, value, ...) \arguments{ \item{src}{source object, result of call to an \link{src} function} -\item{key}{(chartacter) A key. ignored for mongo} +\item{key}{(character) A key (collection for mongo)} \item{value}{(data.frame) A single data.frame} @@ -47,7 +47,7 @@ docdb_get(src, "mtcars") docdb_delete(src, "mtcars") # MongoDB -src <- src_mongo() +src <- src_mongo(collection = "mtcars") docdb_create(src, key = "mtcars", value = mtcars) docdb_get(src, "mtcars") diff --git a/man/docdb_delete.Rd b/man/docdb_delete.Rd index 8bd8c1d..53266f5 100644 --- a/man/docdb_delete.Rd +++ b/man/docdb_delete.Rd @@ -10,7 +10,7 @@ docdb_delete(src, key, ...) \item{src}{source object, result of call to src, an object of class \code{docdb_src}} -\item{key}{(chartacter) A key. ignored for mongo} +\item{key}{(character) A key (collection for mongo)} \item{...}{Ignored for now} } @@ -48,7 +48,7 @@ docdb_get(src, "mtcars") docdb_delete(src, "mtcars") # mongo -src <- src_mongo("stuff") +src <- src_mongo(collection = "iris") docdb_create(src, "iris", iris) docdb_get(src, "iris") docdb_delete(src) diff --git a/man/docdb_get.Rd b/man/docdb_get.Rd index 99d44e9..970b76c 100644 --- a/man/docdb_get.Rd +++ b/man/docdb_get.Rd @@ -9,7 +9,7 @@ docdb_get(src, key, limit = NULL, ...) \arguments{ \item{src}{source object, result of call to src} -\item{key}{(chartacter) A key. ignored for mongo} +\item{key}{(character) A key (collection for mongo)} \item{limit}{(integer) number of records/rows to return. by default not passed, so you get all results. Only works for CouchDB, @@ -58,7 +58,7 @@ docdb_create(src, "mtcars", mtcars) docdb_get(src, "mtcars") # Mongo -src <- src_mongo() +src <- src_mongo(collection = "mtcars") docdb_create(src, "mtcars", mtcars) docdb_get(src, "mtcars") docdb_get(src, "mtcars", limit = 4) diff --git a/man/docdb_query.Rd b/man/docdb_query.Rd index 9abee14..57b0005 100644 --- a/man/docdb_query.Rd +++ b/man/docdb_query.Rd @@ -9,7 +9,7 @@ docdb_query(src, key, query, ...) \arguments{ \item{src}{source object, result of call to src} -\item{key}{(chartacter) A key. ignored for mongo} +\item{key}{(character) A key (collection for mongo)} \item{query}{various. see Query section below.} @@ -76,7 +76,7 @@ docdb_query(src, "iris", query = "1.5") docdb_query(src, "iris", query = "Petal.Width:1.5") # Mongo -src <- src_mongo() +src <- src_mongo(collection = "mtcars") if (docdb_exists(src, "mtcars")) docdb_delete(src, "mtcars") docdb_create(src, "mtcars", mtcars) docdb_query(src, query = '{"mpg":21}') diff --git a/man/docdb_update.Rd b/man/docdb_update.Rd index ac5759b..dc84930 100644 --- a/man/docdb_update.Rd +++ b/man/docdb_update.Rd @@ -9,7 +9,7 @@ docdb_update(src, key, value, ...) \arguments{ \item{src}{source object, result of call to src} -\item{key}{(chartacter) A key. ignored for mongo} +\item{key}{(character) A key (collection for mongo)} \item{value}{(data.frame) A single data.frame}