dot-federateCov: Federated covariance matrix

.federateCovR Documentation

Federated covariance matrix

Description

Compute the covariance matrix for the virtual cohort

Usage

.federateCov(
  loginFD,
  logins,
  funcPreProc,
  querytables,
  querysubset = NULL,
  pair = FALSE,
  chunk = 500L,
  mc.cores = 1,
  connRes = FALSE
)

Arguments

loginFD

Login information of the FD server (one of the servers containing cohort data)

logins

Login information of other servers containing cohort data

funcPreProc

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).

querytables

Name (or a vector of two names) of the R symbol(s) to assign in the Datashield R session on each server in logins. The assigned R variable(s) will be used as the input raw data to compute covariance matrix. Other assigned R variables in func are ignored.

querysubset

A list of index vectors indicating the subsets of individuals to consider. Default, NULL, all individuals are considered.

pair

A logical value indicating pairwise cross products are computed. 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.

connRes

A logical value indicating if the connection to logins is returned. Default, no.

Value

Covariance matrix of the virtual cohort


vanduttran/dsSSCP documentation built on Jan. 17, 2025, 1:47 a.m.