Learn R Programming

dsBase

DataSHIELD server side base R library.

About

DataSHIELD is a software package which allows you to do non-disclosive federated analysis on sensitive data. Our website (https://www.datashield.org) has in depth descriptions of what it is, how it works and how to install it. A key point to highlight is that DataSHIELD has a client-server infrastructure, so the dsBase package (https://github.com/datashield/dsBase) needs to be used in conjuction with the dsBaseClient package (https://github.com/datashield/dsBaseClient) - trying to use one without the other makes no sense.

Detailed instructions on how to install DataSHIELD are at https://wiki.datashield.org/. The code here is organised as:

Location	What is it?
obiba CRAN	Where you probably should install DataSHIELD from.
releases	Stable releases.
master branch	Mostly in sync with the latest release, changes rarely.

Copy Link

Version

Install

install.packages('dsBase')

Version

6.3.3

License

GPL-3

Maintainer

Stuart Wheater

Last Published

July 19th, 2025

Functions in dsBase (6.3.3)

Tests for correlation between paired samples

Returns the column names of a data frame or matrix

glmDS2 called by ds.glm

cbindDS called by ds.cbind

dataFrameDS called by ds.dataFrame

changeRefGroupDS

Changes a reference level of a factor

Create the identity stats and necessary data to draw a plot on the client

blackBoxRanksDS

Secure ranking of "V2BR" (vector to be ranked) across all sources

dataFrameFillDS

dataFrameFillDS

glmPredictDS.ag

predict regression responses from a glm object

returns the minimum and the maximum of the input numeric vector

glmSummaryDS.as

summarize a glm object on the serverside

extractQuantilesDS2

Secure ranking of "V2BR" (vector to be ranked) across all sources and use of these ranks to estimate global quantiles across all studies

completeCasesDS

completeCasesDS: an assign function called by ds.completeCases

Computes the sum of each variable and the sum of products for each pair of variables

glmSummaryDS.ag

summarize a glm object on the serverside

Computes the sum of each variable and the sum of products for each pair of variables

gamlssDS an aggregate function called by ds.galmss

Coerce objects into a list

Concatenates objects into a vector or list

dataFrameSortDS

Sorting and reordering data frames, vectors or matrices

Calculates Blood pressure z-scores

dataFrameSubsetDS1

dataFrameSubsetDS1 an aggregate function called by ds.dataFrameSubset

matrixMultDS serverside assign function called by ds.matrixMult

@title lexisDS3

Computes a histogram of the input variable without plotting.

lmerSLMADS.assign

Fitting linear mixed effect models - serverside function

matrixTransposeDS

matrixTransposeDS serverside assign function called by ds.matrixTranspose

Fitting linear mixed effect models - serverside function

Fit a Generalized Linear Model (GLM) with pooling via Study Level Meta-Analysis (SLMA)

Fit a Generalized Linear Model (GLM) with pooling via Study Level Meta-Analysis (SLMA)

listDisclosureSettingsDS

listDisclosureSettingsDS

dataFrameSubsetDS2

dataFrameSubsetDS2 an assign function called by ds.dataFrameSubset

Generates a density grid with or without a priori defined limits

matrixDetDS assign function called by ds.matrixDet

Checks if an input is valid

matrixDiagDS assign function called by ds.matrixDiag

Returns the dimension of a data frame or matrix

Copy a clientside data.frame, matrix or tibble (DMT) to the serverside.

Secure ranking of "V2BR" (vector to be ranked) across all sources

returns the minimum and maximum of a numeric vector

Calculates the kurtosis of a numeric variable

Return the names of a list object

rNormDS serverside assign function

repDS called by ds.rep

rBinomDS serverside assign function

Replaces the missing values in a vector

Basis for a piecewise linear spline with meaningful coefficients

Computes sums and means of rows or columns of numeric arrays

rmDS an aggregate function called by ds.rm

Secure ranking of "V2BR" (vector to be ranked) across all sources

Secure ranking of "V2BR" (vector to be ranked) across all sources

extractQuantilesDS1

Secure ranking of "V2BR" (vector to be ranked) across all sources and use of these ranks to estimate global quantiles across all studies

glmPredictDS.as

predict regression responses from a glm object

glmSLMADS.assign

Fit a Generalized Linear Model (GLM) with pooling via Study Level Meta-Analysis (SLMA)

glmerSLMADS.assign

Fitting generalized linear mixed effect models - serverside function

Fitting generalized linear mixed effect models - serverside function

unListDS a serverside assign function called by ds.unList

Creates a vector on the server-side.

testObjExistsDS

testObjExistsDS

Returns the levels of a factor vector

lists all objects on a serverside environment

Generate a Basis Matrix for Natural Cubic Splines

Checks if a vector is empty

Aggregate function called by ds.mice

matrixDS assign function called by ds.matrix

Returns the metadata, if any, about the specified variable

matrixDetDS aggregate function called by ds.matrixDet.report

igb_standardsDS

Converts birth measurements to intergrowth z-scores/centiles

Calculates the skewness of a numeric variable

Calculates the skewness of a numeric variable

tableDS.assign is the serverside assign function called by ds.table

Secure ranking of "V2BR" (vector to be ranked) across all sources

Secure ranking of "V2BR" (vector to be ranked) across all sources

Secure ranking of "V2BR" (vector to be ranked) across all sources

mergeDS (assign function) called by ds.merge

Basis for a piecewise linear spline with meaningful coefficients

Counts the number of missing values

rPoisDS serverside assign function

tableDS is the second of two serverside aggregate functions called by ds.table

rUnifDS serverside assign function

rbindDS called by ds.rbind

seqDS a serverside assign function called by ds.seq

setSeedDs called by ds.setSeed, ds.rNorm, ds.rUnif, ds.rPois and ds.rBinom

reShapeDS (assign function) called by ds.reShape

Returns the length of a vector or list

Heterogeneous Correlation Matrix

Calculates the coordinates of the centroid of each n nearest neighbours

Calculates the kurtosis of a numeric variable

glmDS1 called by ds.glm

Computes the WHO Growth Reference z-scores of anthropometric data

tapplyDS called by ds.tapply

Computes the square root values of the input variable

Applies the unique method to a server-side variable.

tapplyDS.assign

tapplyDS.assign called by ds.tapply.assign

Computes the variance of vector

subsetByClassDS

Breaks down a dataframe or a factor into its sub-classes

matrixInvertDS serverside assign function called by ds.matrixInvert

matrixDimnamesDS

matrixDimnamesDS assign function called by ds.matrixDimnames

Recodes the levels of a categorical variables

Computes statistical mean of a vectores

recodeValuesDS an assign function called by ds.recodeValues

Generates a valid subset of a table or a vector

Creates 1-dimensional contingency tables

Generates quantiles and mean information without maximum and minimum

Basis for a piecewise linear spline with meaningful coefficients

random sampling and permuting of vectors, dataframes and matrices

table2DDS (aggregate function) called by ds.table2D

tableDS is the first of two serverside aggregate functions called by ds.table

Calculates the coordinates of the data to be plot

Converts a numeric vector into a factor

Coerces an R object into class integer

Coerces an R object into class numeric

asListDS a serverside aggregate function called by ds.asList

Computes the absolute values of the input variable

asFactorSimpleDS

Converts a numeric vector into a factor

Determines the levels of the input variable in each single study

asDataMatrixDS a serverside assign function called by ds.asDataMatrix

Coerces an R object into class character

Coerces an R object into class numeric

Coerces an R object into a matrix

boxPlotGG_data_TreatmentDS

Arrange data frame to pass it to the boxplot function

boxPlotGG_data_Treatment_numericDS

Arrange vector to pass it to the boxplot function

aucDS an aggregate function called by ds.auc

Returns the class of an object

Secure ranking of "V2BR" (vector to be ranked) across all sources

checkNegValueDS

Checks if a numeric variable has negative values

checkPermissivePrivacyControlLevel

checkPermissivePrivacyControlLevel