exec: Wrapper call function for non-disclosive federated analysis

In vanduttran/dsMO: Client Side Functions for Federated Multi-Omics Analysis on the Virtual Cohort

Wrapper call function for non-disclosive federated analysis

Description

This wrapper function is used to call all the federated analysis functions provided in the dsMO package suite.

Usage

exec(name, loginFD, logins, func, symbol, ...)

Arguments

name	A character string naming the function to be called, among federatePCA, federateRCCA, federateComDim, federateSNF, federateUMAP, federateHdbscan.
loginFD	Login information of the federated server, where the function name will be executed. For functions using X'X, such as federatePCA, federateRCCA, this should be a server with dsMOprimal installed. For functions using XX', such as federateComDim, federateSNF, federateUMAP, federateHdbscan, this should be a server with dsMOdual installed.
logins	Login information of data repositories, where dsMOprimal is installed.
func	Definition of a function for preparation of raw data matrices.
symbol	The symbol provided when calling the function func for data preparation.
...	Other arguments of the function name, preferably in the same order.

Examples

data(logindata)
data(procFunc)

res.pca <- exec('federatePCA',
                 loginFD=logindata[1,],
                 logins=logindata[1:2,],
                 func=procFunc$SingleOmics,
                 symbol='rawDataX')
res.rcca <- exec('federateRCCA',
                  loginFD=logindata[1,],
                  logins=logindata[1:2,],
                  func=procFunc$BiOmics,
                  symbol=c('rawDataX', 'rawDataY'),
                  lambda1=0.001,
                  lambda2=0.001,
                  tune=FALSE)
res.comdim <- exec('federateComDim',
                    loginFD=logindata[3,],
                    logins=logindata[1:2,],
                    func=procFunc$BiOmics,
                    symbol=c('rawDataX', 'rawDataY'),
                    ncomp=2,
                    scale='none',
                    option='uniform')
res.snf <- exec('federateSNF',
                 loginFD=logindata[3,],
                 logins=logindata[1:2,],
                 func=procFunc$BiOmics,
                 symbol=c('rawDataX', 'rawDataY'))
res.umap <- exec('federateUMAP',
                  loginFD=logindata[3,],
                  logins=logindata[1:2,],
                  func=procFunc$BiOmics,
                  symbol=c('rawDataX', 'rawDataY'))
res.hdbscan <- exec('federateHdbscan',
                     loginFD=logindata[3,],
                     logins=logindata[1:2,],
                     func=procFunc$BiOmics,
                     symbol=c('rawDataX', 'rawDataY'))

vanduttran/dsMO documentation built on Oct. 17, 2024, 1:14 a.m.