Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

mention cran in README

	modified:   README.md
  • Loading branch information...
commit 3ee20d38aad39f418f3c61ae280b513731c6f13e 1 parent 00c8d58
@wactbprot authored
Showing with 22 additions and 21 deletions.
  1. +22 −21 README.md
View
43 README.md
@@ -1,42 +1,43 @@
-<pre>
+```
__ _ _ ___ _ ___ ___
/__\ || | / __\___ _ _ ___| |__ / \/ __\
/ \// || |_ / / / _ \| | | |/ __| '_ \ / /\ /__\//
/ _ \__ _/ /__| (_) | |_| | (__| | | |/ /_// \/ \
\/ \_/ |_| \____/\___/ \__,_|\___|_| |_/___,'\_____/
-</pre>
+```
## A Collection of R functions for CouchDB access
The R4CouchDB package provides a collection of functions for
basic database and document management operations such as add and
-delete.
+delete.
Every cdbFunction() gets and emits a list containing the
connection set up.
With the cdbIni() function the cdb$serverName is set to
-"localhost" as a default.
+"localhost" as a default.
There are some examples below the demo folder.
**Note:** Check out [*sofa*](https://github.com/SChamberlain/sofa), from
-@recology_ another R package to interact with CouchDB.
+@recology_ another R package to interact with CouchDB.
## Getting started
-* download latest version or clone repository
-* open a shell and install the package with:
-
- R CMD INSTALL R4CouchDB
-
- dependencies (bitopts, RCurl, RJSONIO) can be
- installed in the same way
+* R4CouchDB is is available over
+ (http://cran.r-project.org/web/packages/R4CouchDB/index.html)[http://cran.r-project.org]. This
+ means that one can use the R command
+
+ ```
+ > install.packages("R4CouchDB")
+```
+ (please be aware of the fact that beside ```R-base-devel``` must be installed Rcurl needs ```libcurl-devel```)
+
+* an further way for those who have _devtools_ installed is
-* an easier way for those who have _devtools_ installed is
-
library(devtools)
install_github('R4CouchDB', 'wactbprot', subdir = 'R4CouchDB')
-
+
(see e.g. http://www.inside-r.org/packages/cran/devtools/docs/install_github)
* open R shell and load library with:
@@ -63,9 +64,9 @@ There are some examples below the demo folder.
function(i){
foo$dataList <- i
cdbAddDoc(foo)$error
- })
+ })
+
-
* get angry and write a ticket or mail
## Problems
@@ -94,13 +95,13 @@ In cdbIni I added with 0.1.2 the lines:
return(jsn)
}
- The point is: one can have a
+ The point is: one can have a
- {"a":"\r"}
+ {"a":"\r"}
in the database but one can not send it back
this way. A \r is here replaced by \\r
-resulting in \r in the database.
+resulting in \r in the database.
The gsub statement behaves like this:
> gsub("\\r","\\\\r","\r")
@@ -112,7 +113,7 @@ The gsub statement behaves like this:
> gsub("\\r","\\\\r","\\\\r")
[1] "\\\\r"
-I'm not happy
+I'm not happy
with this but have no better solution for the moment.
Please sign in to comment.
Something went wrong with that request. Please try again.