federateComDim: Federated ComDim

View source: R/client_func.R

federateComDimR Documentation

Federated ComDim

Description

Function for ComDim federated analysis on the virtual cohort combining multiple cohorts: finding common dimensions in multiblock data.

Usage

federateComDim(loginFD,
                      logins,
                      func,
                      symbol,
                      ncomp = 2,
                      scale = FALSE,
                      scale.block = TRUE,
                      threshold = 1e-8,
                      chunk = 500L,
                      mc.cores = 1,
                      width.cutoff = 500L
                      )

Arguments

loginFD

Login information of the FD server

logins

Login information of data repositories

func

Encoded definition of a function for preparation of raw data matrices. Two arguments are required: conns (list of Opal connections), symbol (name of the R symbol) (see datashield.assign).

symbol

Encoded vector of names of the R symbols to assign in the DataSHIELD R session on each server in logins. The assigned R variables will be used as the input raw data. Other assigned R variables in func are ignored.

ncomp

Number of common dimensions

scale

A logical value indicating if variables are scaled to unit variance. Default, FALSE. See MBAnalysis::ComDim.

scale.block

A logical value indicating if each block of variables is divided by the square root of its inertia. Default, TRUE. See MBAnalysis::ComDim.

threshold

if the difference of fit<threshold then break the iterative loop (default 1e-8).

chunk

Size of chunks into what the resulting matrix is partitioned. Default, 500L.

mc.cores

Number of cores for parallel computing. Default, 1.

TOL

Tolerance of 0. Default, .Machine$double.eps.

width.cutoff

Default, 500L. See deparse1.

Value

A ComDim object. See MBAnalysis::ComDim.


vanduttran/dsMOdual documentation built on Jan. 19, 2025, 6:36 a.m.