README.md

In stefvanbuuren/dsMice: DataSHIELD server-side functions for the mice package

dsMice

Multivariate Imputation by Chained Equations for DataSHIELD - Server

The mice package creates multiple imputations (replacement values) for multivariate missing data.

The DataSHIELD framework is a platform for federated data analysis that brings the algorithm to the data.

The dsMiceClient package is an add-on to mice that makes multiple imputation available for federated data systems. This is the package that the DataSHIELD end user installs locally.

The dsMice package is part of the DataSHIELD infrastructure. This is the package that the DataSHIELD node owner installs on the server.

Installation

The following code installs the dsMice package on the node server:

Install the opaladmin dependence using the R console.

install.packages('opaladmin', repos=c('http://cran.rstudio.com/', 'http://cran.obiba.org'), dependencies=TRUE)

Call the opal and opaladmin library.

library(opal)
library(opaladmin)

Connect to data nodes.

o <- opal.login(username = 'user', password = 'pass', url = "https://node-address-1")
o2 <- opal.login(username = 'user', password = 'pass', url = "https://node-address-2")
o3 <- opal.login(username = 'user', password = 'pass', url = 'https://node-address-3')

Remove old version of the package (if you have installed it before).

if ("dsMice" %in% rownames(installed.packages())) dsadmin.remove_package(o, 'dsMice')
if ("dsMice" %in% rownames(installed.packages())) dsadmin.remove_package(o2, 'dsMice')
if ("dsMice" %in% rownames(installed.packages())) dsadmin.remove_package(o3, 'dsMice')

Install the package devtools into data node (only for the first run).

oadmin.install_devtools(o)
oadmin.install_devtools(o2)
oadmin.install_devtools(o3)

Download the package from Git repository to data nodes.

cmd <- paste('devtools::install_github("stefvanbuuren/dsMice")')
opal.execute(o, cmd)
opal.execute(o2, cmd)
opal.execute(o3, cmd)

Install the package into data nodes

dsadmin.install_package(o, 'dsMice')
dsadmin.install_package(o2, 'dsMice')
dsadmin.install_package(o3, 'dsMice')

Publish the package's DataSHIELD methods

dsadmin.set_package_methods(o, 'dsMice')
dsadmin.set_package_methods(o2, 'dsMice')
dsadmin.set_package_methods(o3, 'dsMice')

Logout from Opal

opal.logout(o)
opal.logout(o2)
opal.logout(o3)

In order to work well, the end user should that the dsMiceClient package installed locally.

Note

Warning: This is an experimental feature. These function do not yet actually work. If you have ideas about the integration of mice and DataSHIELD feel free to join in.

Related initiative

Related work appears in gflcampos/dsMice and gflcampos/dsMiceClient.

Minimal example

Include minimal example here using public DataSHIELD nodes.

stefvanbuuren/dsMice documentation built on Aug. 26, 2020, 1:44 p.m.