dot-federateSSCP: Federated SSCP

.federateSSCPR Documentation

Federated SSCP

Description

Function for computing the federated SSCP matrix.

Usage

.federateSSCP(
  loginFD,
  logins,
  funcPreProc,
  querytables,
  byColumn = TRUE,
  scale = FALSE,
  chunk = 500L,
  mc.cores = 1,
  TOL = .Machine$double.eps,
  width.cutoff = 500L,
  connRes = FALSE
)

Arguments

loginFD

Login information of the FD server

logins

Login information of data repositories

funcPreProc

Definition of a function for preparation of raw data matrices. Two arguments are required: conns (list of DSConnection-classes), symbol (name of the R symbol) (see datashield.assign).

querytables

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 funcPreProc are ignored.

byColumn

A logical value indicating whether the input data is centered by column or row. Default, TRUE, centering by column, with constant variables across samples are removed. If FALSE, centering and scaling by row, with constant samples across variables are removed.

scale

A logical value indicating whether the variables should be scaled to have unit variance. Default, FALSE.

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.

connRes

A logical value indicating if the connection to logins is returned. Default, FALSE, connections are closed.


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