-
Notifications
You must be signed in to change notification settings - Fork 17
/
README.Rmd
126 lines (87 loc) · 3.27 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
---
title: 'sofa'
output: md_document
---
```{r, echo=FALSE}
knitr::opts_chunk$set(
collapse=TRUE,
comment="#>",
warning=FALSE,
message=FALSE
)
```
# sofa <img src="man/figures/logo.png" width=120px align="right" />
<!-- badges: start -->
[](https://CRAN.R-project.org/package=sofa)
[](https://www.repostatus.org/#active)
[](https://github.com/ropensci/sofa/actions)
[](https://codecov.io/github/ropensci/sofa?branch=master)
[](https://github.com/metacran/cranlogs.app)
<!-- badges: end -->
__An easy interface to CouchDB from R__
sofa docs: https://docs.ropensci.org/sofa/
## CouchDB versions
`sofa` works with CouchDB v2 and v3. See [the builds](https://github.com/ropensci/sofa/actions?query=workflow%3AR-check) for checks on various CouchDB versions.
## CouchDB Info
* Docs: <https://docs.couchdb.org/en/latest/index.html>
* Installation: <https://docs.couchdb.org/en/latest/install/index.html>
## Connect to CouchDB
This may be starting it on your terminal/shell
```sh
couchdb
```
Or opening the CouchDB app on your machine, or running it in Docker. Whatever it
is, start it up.
## Install sofa
From CRAN
```{r eval=FALSE}
install.packages("sofa")
```
Development version from GitHub
```{r eval=FALSE}
remotes::install_github("ropensci/sofa")
```
```{r}
library('sofa')
```
## Cushions
Cushions? What? Since it's couch we gotta use `cushions` somehow. `cushions` are a
connection class containing all connection info to a CouchDB instance.
See `?Cushion` for help.
As an example, connecting to a Cloudant couch:
```{r eval=FALSE}
z <- Cushion$new(
host = "stuff.cloudant.com",
transport = 'https',
port = NULL,
user = 'foobar',
pwd = 'things'
)
```
Break down of parameters:
* `host`: the base url, without the transport (`http`/`https`)
* `path`: context path that is appended to the end of the url
* `transport`: `http` or `https`
* `port`: The port to connect to. Default: 5984. For Cloudant, have to set to `NULL`
* `user`: User name for the service.
* `pwd`: Password for the service, if any.
* `headers`: headers to pass in all requests
If you call `Cushion$new()` with no arguments you get a cushion set up for local
use on your machine, with all defaults used.
```{r eval=FALSE}
x <- Cushion$new()
```
Ping the server
```{r eval=FALSE}
x$ping()
```
Nice, it's working.
## More
See the docs https://docs.ropensci.org/sofa/ for more.
## Meta
* Please [report any issues or bugs](https://github.com/ropensci/sofa/issues).
* License: MIT
* Get citation information for `sofa` in R doing `citation(package = 'sofa')`
* Please note that this project is released with a [Contributor Code of Conduct][coc]. By participating in this project you agree to abide by its terms.
[](https://ropensci.org)
[coc]: https://github.com/ropensci/sofa/blob/master/CODE_OF_CONDUCT.md