ds.sd: Standard Deviation

View source: R/ds.sd.R

ds.sdR Documentation

Standard Deviation

Description

This function computes the standard deviation of the values of a server numerical vector. The SD can be calculated server-wise or pooled

Usage

ds.sd(x, type = "split", checks = FALSE, datasources = NULL)

Arguments

x

character Name of the numeric vector on the server side to obtain it's SD

type

character (default "split") SD for each server ("split") or pooled approach ("combined")

checks

bool (default FALSE) If TRUE optional checks of model components will be undertaken. It is suggested that checks should only be undertaken once the function call has failed.

datasources

a list of DSConnection-class (default NULL) objects obtained after login

Value

list including:

Standard_deviation.by.Study: estimated standard deviation, Nmissing (number of missing observations), Nvalid (number of valid observations) and Ntotal (sum of missing and valid observations) separately for each study (if type = split).
Global.Standard_deviation: estimated standard deviation, Nmissing, Nvalid and Ntotal across all studies combined (if type = combine).
Nstudies: number of studies being analysed.
ValidityMessage: indicates if the analysis was possible.


isglobal-brge/dsMLClient documentation built on March 14, 2023, 1:59 p.m.