-
Notifications
You must be signed in to change notification settings - Fork 7
/
README.Rmd
69 lines (51 loc) · 2.43 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
---
output: github_document
---
<!-- README.md is generated from the source: README.Rmd -->
# distcomp
<!-- badges: start -->
[](https://cran.r-project.org/package=distcomp)
[](https://cran.r-project.org/package=distcomp)
[](https://github.com/bnaras/distcomp/actions/workflows/R-CMD-check.yaml)
<!-- badges: end -->
This package is described in detail in the paper [_Software for Distributed Computation on Medical Databases: A Demonstration Project._](https://doi.org/10.18637/jss.v077.i13)
## Installation
Install this package the usual way in R or via:
```{r, eval = FALSE}
library(devtools)
install_github("bnaras/distcomp")
```
Then, you will find a document that describes several examples
installed under the R library tree. For example:
```{r, eval = FALSE}
list.files(system.file("doc", package = "distcomp"))
list.files(system.file("doc_src", package = "distcomp"))
```
The examples described in the reference below are available as
follows:
```{r, eval = FALSE}
list.files(system.file("ex", package = "distcomp"))
```
Use of this package requires some configuration. In particular, to run
the examples on a local machine where a single `opencpu` server will
be emulating several sites, a suitable R profile needs to be set
up. That profile will be something along the lines of
```{r, eval=FALSE}
library(distcomp)
distcompSetup(workspace = "full_path_to_workspace_directory",
ssl_verifyhost = 0L, ssl_verifypeer = 0L)
```
where the workspace is a directory that the `opencpu` server can
serialize objects to. On Unix or Mac, the above can be inserted into
an `.Rprofile` file, but on Windows, we find that the `Rprofile.site`
file needs to contain the above lines.
The effect of this is that _every R_ process (including the `opencpu`
process) has access to the `distcomp` library and the workspace.
## Prototyping New Computations
Refer to the vignette in the package for some tips on developing new
distributed computations.
## References
Balasubramanian Narasimhan and Daniel Rubin and Samuel Gross and
Marina Bendersky and Philip Lavori. Software for Distributed
Computation on Medical Databases: A Demonstration Project. Journal of
Statistical Software, Volume 77, Issue 13, (2017). [DOI](https://dx.doi.org/10.18637/jss.v077.i13)