From 220d58691f16fbb9188ffa046c538b8ec6557869 Mon Sep 17 00:00:00 2001
From: Stuart Wheater Burton P, Wilson R, Butters O, Ryser-Welch P, Westerberg A, Abarrategui L, Villegas-Diaz R, Avraam D, Marcon Y, Wheater S (2025).
-dsBase: DataSHIELD Server Site Base Functions.
+dsBase: 'DataSHIELD' Server Site Base Functions.
R package version 6.3.3.
A character string taking values 'NA', '1' or '0'. If 'NA'
then any NA values in the
input vector remain as NAs in the output vector. If '1' or '0' NA values in the
-input vector are
-all converted to 1 or 0 respectively.#' @return the levels of the input variable.Citation
@Manual{,
- title = {dsBase: DataSHIELD Server Site Base Functions},
+ title = {dsBase: 'DataSHIELD' Server Site Base Functions},
author = {Paul Burton and Rebecca Wilson and Olly Butters and Patricia Ryser-Welch and Alex Westerberg and Leire Abarrategui and Roberto Villegas-Diaz and Demetris Avraam and Yannick Marcon and Stuart Wheater},
year = {2025},
note = {R package version 6.3.3},
diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml
index 5c084b52..ca6da52a 100644
--- a/docs/pkgdown.yml
+++ b/docs/pkgdown.yml
@@ -2,4 +2,4 @@ pandoc: 3.1.3
pkgdown: 2.1.3
pkgdown_sha: ~
articles: {}
-last_built: 2025-07-01T22:30Z
+last_built: 2025-07-16T10:31Z
diff --git a/docs/reference/BooleDS.html b/docs/reference/BooleDS.html
index 452f7f13..03e2b322 100644
--- a/docs/reference/BooleDS.html
+++ b/docs/reference/BooleDS.html
@@ -81,8 +81,7 @@ Arguments
the levels of the input variable.
+The function converts the input vector into Boolean indicators.
diff --git a/docs/reference/asFactorDS2.html b/docs/reference/asFactorDS2.html index 839d0522..a3ebf298 100644 --- a/docs/reference/asFactorDS2.html +++ b/docs/reference/asFactorDS2.html @@ -69,7 +69,7 @@a boolean that determines whether the new object will be represented as a vector or as a matrix of dummy variables indicating the factor level of each data point. -If this argyment is set to FALSE (default) then the input variable is converted to a factor and +If this argument is set to FALSE (default) then the input variable is converted to a factor and assigned as a vector. If is set to TRUE then the input variable is converted to a factor but assigned as a matrix of dummy variables.
This serverside function check that the server is running in "permissive" privacy control level.
+This server-side function check that the server is running in "permissive" privacy control level.
is a vector of strings which contains the privacy control level names which are permitted by the calling method.
No return value, called for side effects
+Tests whether the R option "datashield.privacyControlLevel" is set to "permissive", if it isn't @@ -63,7 +67,7 @@
a list that includes a matrix with elements the sum of products between each two variables, a matrix with
elements the sum of the values of each variable, a matrix with elements the number of complete cases in each
pair of variables, a list with the number of missing values in each variable separately (columnwise) and the number
-of missing values casewise or pairwise depending on the arqument use, and an error message which indicates
+of missing values casewise or pairwise depending on the argument use, and an error message which indicates
whether or not the input variables pass the disclosure controls. The first disclosure control checks that the number
of variables is not bigger than a percentage of the individual-level records (the allowed percentage is pre-specified
by the 'nfilter.glm'). The second disclosure control checks that none of them is dichotomous with a level having fewer
diff --git a/docs/reference/glmDS1.html b/docs/reference/glmDS1.html
index 38a6a16c..80525b07 100644
--- a/docs/reference/glmDS1.html
+++ b/docs/reference/glmDS1.html
@@ -1,5 +1,5 @@
-
This is the first serverside aggregate function called by ds.glm
+This is the first server-side aggregate function called by ds.glm
List with values from GLM model.
+It is an diff --git a/docs/reference/glmDS2.html b/docs/reference/glmDS2.html index 2cefd28f..0f9df3f4 100644 --- a/docs/reference/glmDS2.html +++ b/docs/reference/glmDS2.html @@ -1,5 +1,5 @@ -
This is the second serverside aggregate function called by ds.glm.
+This is the second server-side aggregate function called by ds.glm.
List with values from GLM model
+It is an aggregate function that uses the model structure and starting diff --git a/docs/reference/heatmapPlotDS.html b/docs/reference/heatmapPlotDS.html index eb3715fa..cf9941b6 100644 --- a/docs/reference/heatmapPlotDS.html +++ b/docs/reference/heatmapPlotDS.html @@ -60,7 +60,7 @@
the number of the nearest neghbours for which their centroid is calculated if the +
the number of the nearest neighbours for which their centroid is calculated if the
method.indicator is equal to 1 (i.e. deterministic method).
The first serverside function called by ds.lexis.
+The first server-side function called by ds.lexis.
a character string specifying the variable holding the time that each individual is censored or fails
List with `max.time`
+This is an aggregate function. diff --git a/docs/reference/lexisDS2.html b/docs/reference/lexisDS2.html index 39b99d50..89ebeabf 100644 --- a/docs/reference/lexisDS2.html +++ b/docs/reference/lexisDS2.html @@ -78,7 +78,7 @@
a clientside generated character string specifying the variable -holding the IDs of indivuals in the data set to be expanded
List with `expanded.table`
+This is the assign @@ -111,7 +115,7 @@
lexisDS3()Data frame with `messageobj` object
+This is an assign function that simplifies the diff --git a/docs/reference/listDisclosureSettingsDS.html b/docs/reference/listDisclosureSettingsDS.html index 10134413..549c94e3 100644 --- a/docs/reference/listDisclosureSettingsDS.html +++ b/docs/reference/listDisclosureSettingsDS.html @@ -49,6 +49,10 @@
listDisclosureSettingsDS()List with DataSHIELD disclosure settings
+For more details see the extensive header for ds.listDisclosureSettings
diff --git a/docs/reference/matrixMultDS.html b/docs/reference/matrixMultDS.html index 6af3ff82..c782eaac 100644 --- a/docs/reference/matrixMultDS.html +++ b/docs/reference/matrixMultDS.html @@ -69,7 +69,7 @@Undertakes standard matrix multiplication where with input matrices A and B with -dimensions A: mxn and B: nxp the output C has dimensions mxp and each elemnt C[i,j] has +dimensions A: mxn and B: nxp the output C has dimensions mxp and each element C[i,j] has value equal to the dot product of row i of A and column j of B where the dot product is obtained as sum(A[i,1]*B[1,j] + A[i,2]*B[2,j] + .... + A[i,n]*B[n,j]). This calculation is only valid if the number of columns of A is the same as the number of rows of B
diff --git a/docs/reference/meanSdGpDS.html b/docs/reference/meanSdGpDS.html index d60d33d7..7e902552 100644 --- a/docs/reference/meanSdGpDS.html +++ b/docs/reference/meanSdGpDS.html @@ -1,5 +1,5 @@ -Serverside function called by ds.meanSdGp
+Server-side function called by ds.meanSdGp
a clientside supplied character string identifying the variable for which +
a client-side supplied character string identifying the variable for which means/SDs are to be calculated
a clientside supplied character string identifying the factor across +
a client-side supplied character string identifying the factor across which means/SDs are to be calculated
List with results from the group statistics
+Computes the mean and standard deviation across groups defined by one diff --git a/docs/reference/scatterPlotDS.html b/docs/reference/scatterPlotDS.html index b1298f5d..2e3d5407 100644 --- a/docs/reference/scatterPlotDS.html +++ b/docs/reference/scatterPlotDS.html @@ -68,7 +68,7 @@
the number of the nearest neghbours for which their centroid is calculated if the +
the number of the nearest neighbours for which their centroid is calculated if the deterministic method is selected.
The function uses the R classical subsetting with squared brackets '[]' and allows also to -subset using a logical oprator and a threshold. The object to subset from must be a vector (factor, numeric -or charcater) or a table (data.frame or matrix).
+subset using a logical operator and a threshold. The object to subset from must be a vector (factor, numeric +or character) or a table (data.frame or matrix).a character, if the input data is a table, if this parameter is provided along with the 'logical' and 'threshold' -parameters, a subtable is based the threshold applied to the speicified variable. This parameter is however ignored if the parameter +parameters, a subtable is based the threshold applied to the specified variable. This parameter is however ignored if the parameter 'rows' and/or 'cols' are provided.
a subset of the vector, matric or dataframe as specified is stored on the server side
+a subset of the vector, matrix or dataframe as specified is stored on the server side
If the input data is a table: The user specifies the rows and/or columns to include in the subset if the input -object is a table; the columns can be refered to by their names. The name of a vector (i.e. a variable) can also be provided +object is a table; the columns can be referred to by their names. The name of a vector (i.e. a variable) can also be provided with a logical operator and a threshold (see example 3). If the input data is a vector: when the parameters 'rows', 'logical' and 'threshold' are all provided the last two are ignored ( 'rows' has precedence over the other two parameters then). diff --git a/docs/reference/table1DDS.html b/docs/reference/table1DDS.html index 6796312e..82d157f7 100644 --- a/docs/reference/table1DDS.html +++ b/docs/reference/table1DDS.html @@ -65,7 +65,7 @@
It generates a 1-dimensional tables where valid (non-disclosive) 1-dimensional tables are defined -as data from sources where no table cells have counts between 1 and the set threshold. When the ouput table +as data from sources where no table cells have counts between 1 and the set threshold. When the output table is invalid all cells but the total count are replaced by missing values. Only the total count is visible on the table returned to the client site. A message is also returned with the 1-dimensional; the message says "invalid table - invalid counts present" if the table is invalid and 'valid table' otherwise.
diff --git a/docs/reference/table2DDS.html b/docs/reference/table2DDS.html index 501a2273..0b5f74e1 100644 --- a/docs/reference/table2DDS.html +++ b/docs/reference/table2DDS.html @@ -69,7 +69,7 @@It generates 2-dimensional contingency tables where valid (non-disclosive) tables are defined -as those where none of their cells have counts between 1 and the set threshold "nfilter.tab". When the ouput table +as those where none of their cells have counts between 1 and the set threshold "nfilter.tab". When the output table is invalid all cells except the total counts are replaced by missing values. Only the total counts are visible on the table returned to the client side. A message is also returned with the 2-dimensional table; the message says "invalid table - invalid counts present" if the table is invalid and 'valid table' otherwise.
diff --git a/docs/reference/testObjExistsDS.html b/docs/reference/testObjExistsDS.html index 09cb4b5f..a0246beb 100644 --- a/docs/reference/testObjExistsDS.html +++ b/docs/reference/testObjExistsDS.html @@ -1,5 +1,5 @@ -The serverside function called by ds.testObjExists
+The server-side function called by ds.testObjExists
List with `test.obj.exists` and `test.obj.class`
+Tests whether a given object exists in
From 4babeed6277bdd6f9a617903536a1a358c6b5c9f Mon Sep 17 00:00:00 2001
From: Stuart Wheater Citation
Burton P, Wilson R, Butters O, Ryser-Welch P, Westerberg A, Abarrategui L, Villegas-Diaz R, Avraam D, Marcon Y, Wheater S (2025). -dsBase: DataSHIELD Server Site Base Functions. +
Burton P, Wilson R, Butters O, Ryser-Welch P, Westerberg A, Abarrategui L, Villegas-Diaz R, Avraam D, Marcon Y, Wheater S (????). +dsBase: 'DataSHIELD' Server Site Base Functions. R package version 6.3.3.
@Manual{,
- title = {dsBase: DataSHIELD Server Site Base Functions},
+ title = {dsBase: 'DataSHIELD' Server Site Base Functions},
author = {Paul Burton and Rebecca Wilson and Olly Butters and Patricia Ryser-Welch and Alex Westerberg and Leire Abarrategui and Roberto Villegas-Diaz and Demetris Avraam and Yannick Marcon and Stuart Wheater},
- year = {2025},
note = {R package version 6.3.3},
}
+ Gaye A, Marcon Y, Isaeva J, LaFlamme P, Turner A, Jones E, Minion J, Boyd A, Newby C, Nuotio M, Wilson R, Butters O, Murtagh B, Demir I, Doiron D, Giepmans L, Wallace S, Budin-Ljøsne I, Oliver Schmidt C, Boffetta P, Boniol M, Bota M, Carter K, deKlerk N, Dibben C, Francis R, Hiekkalinna T, Hveem K, Kvaløy K, Millar S, Perry I, Peters A, Phillips C, Popham F, Raab G, Reischl E, Sheehan N, Waldenberger M, Perola M, van den Heuvel E, Macleod J, Knoppers B, Stolk R, Fortier I, Harris J, Woffenbuttel B, Murtagh M, Ferretti V, Burton P (2014). +“DataSHIELD: taking the analysis to the data, not the data to the analysis.” +International Journal of Epidemiology, 43(6), 1929–1944. +doi:10.1093/ije/dyu188. +
+@Article{,
+ title = {{DataSHIELD: taking the analysis to the data, not the data to the analysis}},
+ author = {Amadou Gaye and Yannick Marcon and Julia Isaeva and Philippe {LaFlamme} and Andrew Turner and Elinor M Jones and Joel Minion and Andrew W Boyd and Christopher J Newby and Marja-Liisa Nuotio and Rebecca Wilson and Oliver Butters and Barnaby Murtagh and Ipek Demir and Dany Doiron and Lisette Giepmans and Susan E Wallace and Isabelle Budin-Lj{\o}sne and Carsten {{Oliver Schmidt}} and Paolo Boffetta and Mathieu Boniol and Maria Bota and Kim W Carter and Nick {deKlerk} and Chris Dibben and Richard W Francis and Tero Hiekkalinna and Kristian Hveem and Kirsti Kval{\o}y and Sean Millar and Ivan J Perry and Annette Peters and Catherine M Phillips and Frank Popham and Gillian Raab and Eva Reischl and Nuala Sheehan and Melanie Waldenberger and Markus Perola and Edwin {{van den Heuvel}} and John Macleod and Bartha M Knoppers and Ronald P Stolk and Isabel Fortier and Jennifer R Harris and Bruce H R Woffenbuttel and Madeleine J Murtagh and Vincent Ferretti and Paul R Burton},
+ journal = {International Journal of Epidemiology},
+ year = {2014},
+ volume = {43},
+ number = {6},
+ pages = {1929--1944},
+ doi = {10.1093/ije/dyu188},
+}
+ Wilson R, W. Butters O, Avraam D, Baker J, Tedds J, Turner A, Murtagh M, R. Burton P (2017). +“DataSHIELD – New Directions and Dimensions.” +Data Science Journal, 16(21), 1–21. +doi:10.5334/dsj-2017-021. +
+@Article{,
+ title = {{DataSHIELD – New Directions and Dimensions}},
+ author = {Rebecca C. Wilson and Oliver {W. Butters} and Demetris Avraam and James Baker and Jonathan A. Tedds and Andrew Turner and Madeleine Murtagh and Paul {R. Burton}},
+ journal = {Data Science Journal},
+ year = {2017},
+ volume = {16},
+ number = {21},
+ pages = {1--21},
+ doi = {10.5334/dsj-2017-021},
+}
+ Avraam D, Wilson R, Aguirre Chan N, Banerjee S, Bishop T, Butters O, Cadman T, Cederkvist L, Duijts L, Escribà Montagut X, Garner H, Gonçalves G, González J, Haakma S, Hartlev M, Hasenauer J, Huth M, Hyde E, Jaddoe V, Marcon Y, Mayrhofer M, Molnar-Gabor F, Morgan A, Murtagh M, Nestor M, Nybo Andersen A, Parker S, Pinot de Moira A, Schwarz F, Strandberg-Larsen K, Morris AvSwertz, Welten M, Wheater S, Burton P (2024). +“DataSHIELD: mitigating disclosure risk in a multi-site federated analysis platform.” +Bioinformatics Advances, 5(1), 1–21. +doi:10.1093/bioadv/vbaf046. +
+@Article{,
+ title = {{DataSHIELD: mitigating disclosure risk in a multi-site federated analysis platform}},
+ author = {Demetris Avraam and Rebecca C Wilson and Noemi {{Aguirre Chan}} and Soumya Banerjee and Tom R P Bishop and Olly Butters and Tim Cadman and Luise Cederkvist and Liesbeth Duijts and Xavier {{Escrib{\a`a} Montagut}} and Hugh Garner and Gon{\c c}alo {Gon{\c c}alves} and Juan R Gonz{\a'a}lez and Sido Haakma and Mette Hartlev and Jan Hasenauer and Manuel Huth and Eleanor Hyde and Vincent W V Jaddoe and Yannick Marcon and Michaela Th Mayrhofer and Fruzsina Molnar-Gabor and Andrei Scott Morgan and Madeleine Murtagh and Marc Nestor and Anne-Marie {{Nybo Andersen}} and Simon Parker and Angela {{Pinot de Moira}} and Florian Schwarz and Katrine Strandberg-Larsen and {Morris AvSwertz} and Marieke Welten and Stuart Wheater and Paul Burton},
+ journal = {Bioinformatics Advances},
+ year = {2024},
+ volume = {5},
+ number = {1},
+ pages = {1--21},
+ doi = {10.1093/bioadv/vbaf046},
+ editor = {Thomas Lengauer},
+ publisher = {Oxford University Press (OUP)},
+}
+install.packages("remotes")
+remotes::install_github("datashield/dsBase", "<BRANCH>")
+
+# Install v6.4.0 with the following
+remotes::install_github("datashield/dsBase", "v6.4.0-dev")For a full list of development branches, checkout https://github.com/datashield/dsBase/branches
+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:
[1] Burton P, Wilson R, Butters O, Ryser-Welch P, Westerberg A, Abarrategui L, Villegas-Diaz R, Avraam D, Marcon Y, Bishop T, Gaye A, Escribà Montagut X, Wheater S (2025). dsBase: ‘DataSHIELD’ Server Side Base Functions. R package version 6.3.3. https://doi.org/10.32614/CRAN.package.dsBase.
+[2] Gaye A, Marcon Y, Isaeva J, LaFlamme P, Turner A, Jones E, Minion J, Boyd A, Newby C, Nuotio M, Wilson R, Butters O, Murtagh B, Demir I, Doiron D, Giepmans L, Wallace S, Budin-Ljøsne I, Oliver Schmidt C, Boffetta P, Boniol M, Bota M, Carter K, deKlerk N, Dibben C, Francis R, Hiekkalinna T, Hveem K, Kvaløy K, Millar S, Perry I, Peters A, Phillips C, Popham F, Raab G, Reischl E, Sheehan N, Waldenberger M, Perola M, van den Heuvel E, Macleod J, Knoppers B, Stolk R, Fortier I, Harris J, Woffenbuttel B, Murtagh M, Ferretti V, Burton P (2014). “DataSHIELD: taking the analysis to the data, not the data to the analysis.” International Journal of Epidemiology, 43(6), 1929-1944. https://doi.org/10.1093/ije/dyu188.
+[3] Wilson R, W. Butters O, Avraam D, Baker J, Tedds J, Turner A, Murtagh M, R. Burton P (2017). “DataSHIELD – New Directions and Dimensions.” Data Science Journal, 16(21), 1-21. https://doi.org/10.5334/dsj-2017-021.
+[4] Avraam D, Wilson R, Aguirre Chan N, Banerjee S, Bishop T, Butters O, Cadman T, Cederkvist L, Duijts L, Escribà Montagut X, Garner H, Gonçalves G, González J, Haakma S, Hartlev M, Hasenauer J, Huth M, Hyde E, Jaddoe V, Marcon Y, Mayrhofer M, Molnar-Gabor F, Morgan A, Murtagh M, Nestor M, Nybo Andersen A, Parker S, Pinot de Moira A, Schwarz F, Strandberg-Larsen K, Morris AvSwertz, Welten M, Wheater S, Burton P (2024). “DataSHIELD: mitigating disclosure risk in a multi-site federated analysis platform.” Bioinformatics Advances, 5(1), 1-21. https://doi.org/10.1093/bioadv/vbaf046.
This is the first serverside aggregate function called by ds.glm
+This is the first server-side aggregate function called by ds.glm
List with values from GLM model.
+It is an diff --git a/docs/reference/glmDS2.html b/docs/reference/glmDS2.html index 2cefd28f..0f9df3f4 100644 --- a/docs/reference/glmDS2.html +++ b/docs/reference/glmDS2.html @@ -1,5 +1,5 @@ -
This is the second serverside aggregate function called by ds.glm.
+This is the second server-side aggregate function called by ds.glm.
List with values from GLM model
+It is an aggregate function that uses the model structure and starting diff --git a/docs/reference/heatmapPlotDS.html b/docs/reference/heatmapPlotDS.html index eb3715fa..cf9941b6 100644 --- a/docs/reference/heatmapPlotDS.html +++ b/docs/reference/heatmapPlotDS.html @@ -60,7 +60,7 @@
the number of the nearest neghbours for which their centroid is calculated if the +
the number of the nearest neighbours for which their centroid is calculated if the
method.indicator is equal to 1 (i.e. deterministic method).
The first serverside function called by ds.lexis.
+The first server-side function called by ds.lexis.
a character string specifying the variable holding the time that each individual is censored or fails
List with `max.time`
+This is an aggregate function. diff --git a/docs/reference/lexisDS2.html b/docs/reference/lexisDS2.html index 39b99d50..89ebeabf 100644 --- a/docs/reference/lexisDS2.html +++ b/docs/reference/lexisDS2.html @@ -78,7 +78,7 @@
a clientside generated character string specifying the variable -holding the IDs of indivuals in the data set to be expanded
List with `expanded.table`
+This is the assign @@ -111,7 +115,7 @@
lexisDS3()Data frame with `messageobj` object
+This is an assign function that simplifies the diff --git a/docs/reference/listDisclosureSettingsDS.html b/docs/reference/listDisclosureSettingsDS.html index 10134413..549c94e3 100644 --- a/docs/reference/listDisclosureSettingsDS.html +++ b/docs/reference/listDisclosureSettingsDS.html @@ -49,6 +49,10 @@
listDisclosureSettingsDS()List with DataSHIELD disclosure settings
+For more details see the extensive header for ds.listDisclosureSettings
diff --git a/docs/reference/matrixMultDS.html b/docs/reference/matrixMultDS.html index 6af3ff82..c782eaac 100644 --- a/docs/reference/matrixMultDS.html +++ b/docs/reference/matrixMultDS.html @@ -69,7 +69,7 @@Undertakes standard matrix multiplication where with input matrices A and B with -dimensions A: mxn and B: nxp the output C has dimensions mxp and each elemnt C[i,j] has +dimensions A: mxn and B: nxp the output C has dimensions mxp and each element C[i,j] has value equal to the dot product of row i of A and column j of B where the dot product is obtained as sum(A[i,1]*B[1,j] + A[i,2]*B[2,j] + .... + A[i,n]*B[n,j]). This calculation is only valid if the number of columns of A is the same as the number of rows of B
diff --git a/docs/reference/meanSdGpDS.html b/docs/reference/meanSdGpDS.html index d60d33d7..7e902552 100644 --- a/docs/reference/meanSdGpDS.html +++ b/docs/reference/meanSdGpDS.html @@ -1,5 +1,5 @@ -Serverside function called by ds.meanSdGp
+Server-side function called by ds.meanSdGp
a clientside supplied character string identifying the variable for which +
a client-side supplied character string identifying the variable for which means/SDs are to be calculated
a clientside supplied character string identifying the factor across +
a client-side supplied character string identifying the factor across which means/SDs are to be calculated
List with results from the group statistics
+Computes the mean and standard deviation across groups defined by one diff --git a/docs/reference/scatterPlotDS.html b/docs/reference/scatterPlotDS.html index b1298f5d..2e3d5407 100644 --- a/docs/reference/scatterPlotDS.html +++ b/docs/reference/scatterPlotDS.html @@ -68,7 +68,7 @@
the number of the nearest neghbours for which their centroid is calculated if the +
the number of the nearest neighbours for which their centroid is calculated if the deterministic method is selected.
The function uses the R classical subsetting with squared brackets '[]' and allows also to -subset using a logical oprator and a threshold. The object to subset from must be a vector (factor, numeric -or charcater) or a table (data.frame or matrix).
+subset using a logical operator and a threshold. The object to subset from must be a vector (factor, numeric +or character) or a table (data.frame or matrix).a character, if the input data is a table, if this parameter is provided along with the 'logical' and 'threshold' -parameters, a subtable is based the threshold applied to the speicified variable. This parameter is however ignored if the parameter +parameters, a subtable is based the threshold applied to the specified variable. This parameter is however ignored if the parameter 'rows' and/or 'cols' are provided.
a subset of the vector, matric or dataframe as specified is stored on the server side
+a subset of the vector, matrix or dataframe as specified is stored on the server side
If the input data is a table: The user specifies the rows and/or columns to include in the subset if the input -object is a table; the columns can be refered to by their names. The name of a vector (i.e. a variable) can also be provided +object is a table; the columns can be referred to by their names. The name of a vector (i.e. a variable) can also be provided with a logical operator and a threshold (see example 3). If the input data is a vector: when the parameters 'rows', 'logical' and 'threshold' are all provided the last two are ignored ( 'rows' has precedence over the other two parameters then). diff --git a/docs/reference/table1DDS.html b/docs/reference/table1DDS.html index 6796312e..82d157f7 100644 --- a/docs/reference/table1DDS.html +++ b/docs/reference/table1DDS.html @@ -65,7 +65,7 @@
It generates a 1-dimensional tables where valid (non-disclosive) 1-dimensional tables are defined -as data from sources where no table cells have counts between 1 and the set threshold. When the ouput table +as data from sources where no table cells have counts between 1 and the set threshold. When the output table is invalid all cells but the total count are replaced by missing values. Only the total count is visible on the table returned to the client site. A message is also returned with the 1-dimensional; the message says "invalid table - invalid counts present" if the table is invalid and 'valid table' otherwise.
diff --git a/docs/reference/table2DDS.html b/docs/reference/table2DDS.html index 501a2273..0b5f74e1 100644 --- a/docs/reference/table2DDS.html +++ b/docs/reference/table2DDS.html @@ -69,7 +69,7 @@It generates 2-dimensional contingency tables where valid (non-disclosive) tables are defined -as those where none of their cells have counts between 1 and the set threshold "nfilter.tab". When the ouput table +as those where none of their cells have counts between 1 and the set threshold "nfilter.tab". When the output table is invalid all cells except the total counts are replaced by missing values. Only the total counts are visible on the table returned to the client side. A message is also returned with the 2-dimensional table; the message says "invalid table - invalid counts present" if the table is invalid and 'valid table' otherwise.
diff --git a/docs/reference/testObjExistsDS.html b/docs/reference/testObjExistsDS.html index 09cb4b5f..a0246beb 100644 --- a/docs/reference/testObjExistsDS.html +++ b/docs/reference/testObjExistsDS.html @@ -1,5 +1,5 @@ -The serverside function called by ds.testObjExists
+The server-side function called by ds.testObjExists
List with `test.obj.exists` and `test.obj.class`
+Tests whether a given object exists in
From fb2780ac3e1471c2b6de10329982104ae7e84b19 Mon Sep 17 00:00:00 2001
From: Roberto Villegas-Diaz Citation
Burton P, Wilson R, Butters O, Ryser-Welch P, Westerberg A, Abarrategui L, Villegas-Diaz R, Avraam D, Marcon Y, Wheater S (????). -======= -
Burton P, Wilson R, Butters O, Ryser-Welch P, Westerberg A, Abarrategui L, Villegas-Diaz R, Avraam D, Marcon Y, Wheater S (2025). ->>>>>>> refs/remotes/origin/v6.3.3-dev dsBase: 'DataSHIELD' Server Site Base Functions. R package version 6.3.3.
diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml index 7f059d1c..dbbcf4e6 100644 --- a/docs/pkgdown.yml +++ b/docs/pkgdown.yml @@ -2,8 +2,4 @@ pandoc: '3.4' pkgdown: 2.1.3 pkgdown_sha: ~ articles: {} -<<<<<<< HEAD -last_built: 2025-07-23T11:39Z -======= -last_built: 2025-07-16T10:31Z ->>>>>>> refs/remotes/origin/v6.3.3-dev +last_built: 2025-07-23T11:43Z From db494825a6cee80683dbcb7bbbe39f5dd1bf96d6 Mon Sep 17 00:00:00 2001 From: Roberto Villegas-DiazBurton P, Wilson R, Butters O, Ryser-Welch P, Westerberg A, Abarrategui L, Villegas-Diaz R, Avraam D, Marcon Y, Wheater S (????). -dsBase: 'DataSHIELD' Server Site Base Functions. -R package version 6.3.3. +
Burton P, Wilson R, Butters O, Ryser-Welch P, Westerberg A, Abarrategui L, Villegas-Diaz R, Avraam D, Marcon Y, Bishop T, Gaye A, Escribà-Montagut X, Wheater S (????). +dsBase: 'DataSHIELD' Server Side Base Functions. +R package version 6.3.4.
@Manual{,
- title = {dsBase: 'DataSHIELD' Server Site Base Functions},
- author = {Paul Burton and Rebecca Wilson and Olly Butters and Patricia Ryser-Welch and Alex Westerberg and Leire Abarrategui and Roberto Villegas-Diaz and Demetris Avraam and Yannick Marcon and Stuart Wheater},
- note = {R package version 6.3.3},
+ title = {dsBase: 'DataSHIELD' Server Side Base Functions},
+ author = {Paul Burton and Rebecca Wilson and Olly Butters and Patricia Ryser-Welch and Alex Westerberg and Leire Abarrategui and Roberto Villegas-Diaz and Demetris Avraam and Yannick Marcon and Tom Bishop and Amadou Gaye and Xavier Escribà-Montagut and Stuart Wheater},
+ note = {R package version 6.3.4},
}
Gaye A, Marcon Y, Isaeva J, LaFlamme P, Turner A, Jones E, Minion J, Boyd A, Newby C, Nuotio M, Wilson R, Butters O, Murtagh B, Demir I, Doiron D, Giepmans L, Wallace S, Budin-Ljøsne I, Oliver Schmidt C, Boffetta P, Boniol M, Bota M, Carter K, deKlerk N, Dibben C, Francis R, Hiekkalinna T, Hveem K, Kvaløy K, Millar S, Perry I, Peters A, Phillips C, Popham F, Raab G, Reischl E, Sheehan N, Waldenberger M, Perola M, van den Heuvel E, Macleod J, Knoppers B, Stolk R, Fortier I, Harris J, Woffenbuttel B, Murtagh M, Ferretti V, Burton P (2014). “DataSHIELD: taking the analysis to the data, not the data to the analysis.” @@ -152,7 +164,7 @@
Developed by Paul Burton, Rebecca Wilson, Olly Butters, Patricia Ryser-Welch, Alex Westerberg, Leire Abarrategui, Roberto Villegas-Diaz, Demetris Avraam, Yannick Marcon, Stuart Wheater.
+Developed by Paul Burton, Rebecca Wilson, Olly Butters, Patricia Ryser-Welch, Alex Westerberg, Leire Abarrategui, Roberto Villegas-Diaz, Demetris Avraam, Yannick Marcon, Tom Bishop, Amadou Gaye, Xavier Escribà-Montagut, Stuart Wheater.
Generates a density grid that can then be used for heatmap or countour plots.
+Generates a density grid that can then be used for heatmap or contour plots.
a parser-transmissable vector specifying the name of each column +
a parser-transmissible vector specifying the name of each column in the DMT being transferred from clientside to serverside. Generated automatically by clientside function from colnames of clientside DMT.
a parser-transmissable vector specifying the class of the +
a parser-transmissible vector specifying the class of the vector representing each individual column in the DMT to be transferred. Generated automatically by clientside function. This allows the transmission of DMTs containing columns with different classes.If something is going to go wrong with diff --git a/docs/reference/gamlssDS.html b/docs/reference/gamlssDS.html index 4d9a36eb..75d9f900 100644 --- a/docs/reference/gamlssDS.html +++ b/docs/reference/gamlssDS.html @@ -1,5 +1,5 @@ -
gamlssDS.RdComputes a heterogenous correlation matrix, consisting of Pearson product-moment +
Computes a heterogeneous correlation matrix, consisting of Pearson product-moment correlations between numeric variables, polyserial correlations between numeric and ordinal variables, and polychoric correlations between ordinal variables.
gamlssDS an aggregate function called by ds.galmss
gamlssDS an aggregate function called by ds.gamlss
Computes statistical mean of a vectores
Computes statistical mean of a vector
This is the assign function which actually creates -the expanded dataframe containing surival data for a piecewise exponential +the expanded dataframe containing survival data for a piecewise exponential regression. lexisDS2 also carries out a series of disclosure checks and if the arguments or data fail any of those tests, diff --git a/docs/reference/lmerSLMADS.assign.html b/docs/reference/lmerSLMADS.assign.html index a2a8de6a..89fffdec 100644 --- a/docs/reference/lmerSLMADS.assign.html +++ b/docs/reference/lmerSLMADS.assign.html @@ -1,5 +1,5 @@ -
meanDS.Rda list containing the metadata. The elements of the list will depend -on the meatadata available.
+on the metadata available.numeric, a single scalar greater or equal to 2 for a number of equal-frequency -intervals along x or a vector of numbers in (0; 1) specifying the quantiles explicitely.
This argument fixes the length of
-the output repetive sequence vector
+the output repetitive sequence vector
For behaviour see help for ds.rep and "details from native R
help for <rep>" (see above). This parameter is usually fully defined by
the argument <length.out> in the call to ds.rep that itself calls repDS.
It generates a 1-dimensional tables where valid (non-disclosive) 1-dimensional tables are defined as data from sources where no table cells have counts between 1 and the set threshold. When the output table is invalid all cells but the total count are replaced by missing values. Only the total count is visible -on the table returned to the client site. A message is also returned with the 1-dimensional; the message +on the table returned to the client side. A message is also returned with the 1-dimensional; the message says "invalid table - invalid counts present" if the table is invalid and 'valid table' otherwise.
For a full list of development branches, checkout https://github.com/datashield/dsBase/branches
dsBase-package.RdBase 'DataSHIELD' functions for the server side. 'DataSHIELD' is a software package which allows you to do non-disclosive federated analysis on sensitive data. 'DataSHIELD' analytic functions have been designed to only share non disclosive summary statistics, with built in automated output checking based on statistical disclosure control. With data sites setting the threshold values for the automated output checks. For more details, see 'citation("dsBase")'.
+Developed by Paul Burton, Rebecca Wilson, Olly Butters, Patricia Ryser-Welch, Alex Westerberg, Leire Abarrategui, Roberto Villegas-Diaz, Demetris Avraam, Yannick Marcon, Tom Bishop, Amadou Gaye, Xavier Escribà-Montagut, Stuart Wheater.
+Site built with pkgdown 2.1.3.
+[1] Burton P, Wilson R, Butters O, Ryser-Welch P, Westerberg A, Abarrategui L, Villegas-Diaz R, Avraam D, Marcon Y, Bishop T, Gaye A, Escribà Montagut X, Wheater S (2025). dsBase: ‘DataSHIELD’ Server Side Base Functions. R package version 6.3.3. https://doi.org/10.32614/CRAN.package.dsBase.
+[1] Burton P, Wilson R, Butters O, Ryser-Welch P, Westerberg A, Abarrategui L, Villegas-Diaz R, Avraam D, Marcon Y, Bishop T, Gaye A, Escribà Montagut X, Wheater S (2025). dsBase: ‘DataSHIELD’ Server Side Base Functions. R package version 6.3.4. https://doi.org/10.32614/CRAN.package.dsBase.
[2] Gaye A, Marcon Y, Isaeva J, LaFlamme P, Turner A, Jones E, Minion J, Boyd A, Newby C, Nuotio M, Wilson R, Butters O, Murtagh B, Demir I, Doiron D, Giepmans L, Wallace S, Budin-Ljøsne I, Oliver Schmidt C, Boffetta P, Boniol M, Bota M, Carter K, deKlerk N, Dibben C, Francis R, Hiekkalinna T, Hveem K, Kvaløy K, Millar S, Perry I, Peters A, Phillips C, Popham F, Raab G, Reischl E, Sheehan N, Waldenberger M, Perola M, van den Heuvel E, Macleod J, Knoppers B, Stolk R, Fortier I, Harris J, Woffenbuttel B, Murtagh M, Ferretti V, Burton P (2014). “DataSHIELD: taking the analysis to the data, not the data to the analysis.” International Journal of Epidemiology, 43(6), 1929-1944. https://doi.org/10.1093/ije/dyu188.
[3] Wilson R, W. Butters O, Avraam D, Baker J, Tedds J, Turner A, Murtagh M, R. Burton P (2017). “DataSHIELD – New Directions and Dimensions.” Data Science Journal, 16(21), 1-21. https://doi.org/10.5334/dsj-2017-021.
[4] Avraam D, Wilson R, Aguirre Chan N, Banerjee S, Bishop T, Butters O, Cadman T, Cederkvist L, Duijts L, Escribà Montagut X, Garner H, Gonçalves G, González J, Haakma S, Hartlev M, Hasenauer J, Huth M, Hyde E, Jaddoe V, Marcon Y, Mayrhofer M, Molnar-Gabor F, Morgan A, Murtagh M, Nestor M, Nybo Andersen A, Parker S, Pinot de Moira A, Schwarz F, Strandberg-Larsen K, Swertz M, Welten M, Wheater S, Burton P (2024). “DataSHIELD: mitigating disclosure risk in a multi-site federated analysis platform.” Bioinformatics Advances, 5(1), 1-21. https://doi.org/10.1093/bioadv/vbaf046.
diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml index 9659989b..35b3f72f 100644 --- a/docs/pkgdown.yml +++ b/docs/pkgdown.yml @@ -1,5 +1,5 @@ -pandoc: '3.4' +pandoc: 3.1.3 pkgdown: 2.1.3 pkgdown_sha: ~ articles: {} -last_built: 2025-08-21T06:49Z +last_built: 2025-08-28T18:48Z From 719d91840f8af9da5016c79ad7af21dc8fc19a41 Mon Sep 17 00:00:00 2001 From: Roberto Villegas-Diaz[3] Wilson R, W. Butters O, Avraam D, Baker J, Tedds J, Turner A, Murtagh M, R. Burton P (2017). “DataSHIELD – New Directions and Dimensions.” Data Science Journal, 16(21), 1-21. https://doi.org/10.5334/dsj-2017-021.
[4] Avraam D, Wilson R, Aguirre Chan N, Banerjee S, Bishop T, Butters O, Cadman T, Cederkvist L, Duijts L, Escribà Montagut X, Garner H, Gonçalves G, González J, Haakma S, Hartlev M, Hasenauer J, Huth M, Hyde E, Jaddoe V, Marcon Y, Mayrhofer M, Molnar-Gabor F, Morgan A, Murtagh M, Nestor M, Nybo Andersen A, Parker S, Pinot de Moira A, Schwarz F, Strandberg-Larsen K, Swertz M, Welten M, Wheater S, Burton P (2024). “DataSHIELD: mitigating disclosure risk in a multi-site federated analysis platform.” Bioinformatics Advances, 5(1), 1-21. https://doi.org/10.1093/bioadv/vbaf046.
++Note: Apple Mx architecture users, please be aware that there are some numerical limitations on this platform, which leads to unexpected results when using base R packages, li>
+x <- c(0, 3, 7)
+1 - cor(x, x)
+The above should result in a value of zero.
+Also See: For more details see https://cran.r-project.org/doc/FAQ/R-FAQ.html#Why-doesn_0027t-R-think-these-numbers-are-equal_003f and the bug report: https://bugs.r-project.org/sh>
+
[4] Avraam D, Wilson R, Aguirre Chan N, Banerjee S, Bishop T, Butters O, Cadman T, Cederkvist L, Duijts L, Escribà Montagut X, Garner H, Gonçalves G, González J, Haakma S, Hartlev M, Hasenauer J, Huth M, Hyde E, Jaddoe V, Marcon Y, Mayrhofer M, Molnar-Gabor F, Morgan A, Murtagh M, Nestor M, Nybo Andersen A, Parker S, Pinot de Moira A, Schwarz F, Strandberg-Larsen K, Swertz M, Welten M, Wheater S, Burton P (2024). “DataSHIELD: mitigating disclosure risk in a multi-site federated analysis platform.” Bioinformatics Advances, 5(1), 1-21. https://doi.org/10.1093/bioadv/vbaf046.
-From 17cebc056909e7c715cf7243b8704ac762a45ef8 Mon Sep 17 00:00:00 2001 From: Roberto Villegas-DiazNote: Apple Mx architecture users, please be aware that there are some numerical limitations on this platform, which leads to unexpected results when using base R packages, li>
+Note: Apple Mx architecture users, please be aware that there are some numerical limitations on this platform, which leads to unexpected results when using base R packages, like stats.
x <- c(0, 3, 7)
1 - cor(x, x)
The above should result in a value of zero.
-Also See: For more details see https://cran.r-project.org/doc/FAQ/R-FAQ.html#Why-doesn_0027t-R-think-these-numbers-are-equal_003f and the bug report: https://bugs.r-project.org/sh>
+Also See: For more details see https://cran.r-project.org/doc/FAQ/R-FAQ.html#Why-doesn_0027t-R-think-these-numbers-are-equal_003f and the bug report: https://bugs.r-project.org/show_bug.cgi?id=18941