From 8b386dcfdcb2d682296e7fd393675f34664e11b2 Mon Sep 17 00:00:00 2001 From: Roberto Villegas-Diaz Date: Wed, 20 Aug 2025 15:59:47 +0100 Subject: [PATCH 1/3] Fix typos --- R/asDataMatrixDS.R | 2 +- R/checkNegValueDS.R | 2 +- R/densityGridDS.R | 2 +- R/dmtC2SDS.R | 4 ++-- R/gamlssDS.R | 2 +- R/glmerSLMADS.assign.R | 2 +- R/hetcorDS.R | 2 +- R/lexisDS2.R | 2 +- R/lmerSLMADS.assign.R | 4 ++-- R/meanDS.R | 2 +- R/metadataDS.R | 2 +- R/qlsplineDS.R | 2 +- R/repDS.R | 2 +- R/rmDS.R | 2 +- R/table1DDS.R | 2 +- R/tableDS.R | 6 +++--- R/tableDS.assign.R | 6 +++--- R/tableDS2.R | 6 +++--- README.md | 4 ++-- 19 files changed, 28 insertions(+), 28 deletions(-) diff --git a/R/asDataMatrixDS.R b/R/asDataMatrixDS.R index 5b4e5d71..3fff528b 100644 --- a/R/asDataMatrixDS.R +++ b/R/asDataMatrixDS.R @@ -3,7 +3,7 @@ #' class for all columns in data.frames. #' @details This assign function is based on the native R function \code{data.matrix} #' If applied to a data.frame, the native R function \code{as.matrix} -#' coverts all columns into character class. In contrast, if applied to +#' converts all columns into character class. In contrast, if applied to #' a data.frame the native R function \code{data.matrix} converts #' the data.frame to a matrix but maintains all data columns in their #' original class diff --git a/R/checkNegValueDS.R b/R/checkNegValueDS.R index 3f46f3fa..48629138 100644 --- a/R/checkNegValueDS.R +++ b/R/checkNegValueDS.R @@ -1,7 +1,7 @@ #' #' @title Checks if a numeric variable has negative values #' @description this function is only called by the client function \code{ds.glm}. -#' @details if a user sets the parameter 'weights' on the client site function \code{ds.glm} this +#' @details if a user sets the parameter 'weights' on the client side function \code{ds.glm} this #' server side function is called to verify that the 'weights' vector does not have negative values #' because no negative are allowed in weights. #' @param weights a numeric vector diff --git a/R/densityGridDS.R b/R/densityGridDS.R index 786302f7..1569d5c1 100644 --- a/R/densityGridDS.R +++ b/R/densityGridDS.R @@ -1,6 +1,6 @@ #' #' @title Generates a density grid with or without a priori defined limits -#' @description Generates a density grid that can then be used for heatmap or countour plots. +#' @description Generates a density grid that can then be used for heatmap or contour plots. #' @details Invalid cells (cells with count < to the set filter value for the minimum allowed #' counts in table cells) are turn to 0. #' @param xvect a numerical vector diff --git a/R/dmtC2SDS.R b/R/dmtC2SDS.R index 5d315e3d..9b4329ad 100644 --- a/R/dmtC2SDS.R +++ b/R/dmtC2SDS.R @@ -22,10 +22,10 @@ #' @param ncols.transmit specifies the number of columns in the matrix to be created. #' Fixed by the clientside function as equal to the number of columns in #' the clientside DMT to be transferred. -#' @param colnames.transmit a parser-transmissable vector specifying the name of each column +#' @param colnames.transmit 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. -#' @param colclass.transmit a parser-transmissable vector specifying the class of the +#' @param colclass.transmit 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/R/gamlssDS.R b/R/gamlssDS.R index 322f0661..533da0e1 100644 --- a/R/gamlssDS.R +++ b/R/gamlssDS.R @@ -1,5 +1,5 @@ #' -#' @title gamlssDS an aggregate function called by ds.galmss +#' @title gamlssDS an aggregate function called by ds.gamlss #' @description This function calls the gamlssDS that is a wrapper function from #' the gamlss R package. The function returns an object of class "gamlss", which #' is a generalized additive model for location, scale and shape (GAMLSS). The diff --git a/R/glmerSLMADS.assign.R b/R/glmerSLMADS.assign.R index 9e39c72b..df367ea1 100644 --- a/R/glmerSLMADS.assign.R +++ b/R/glmerSLMADS.assign.R @@ -5,7 +5,7 @@ #' The analytic work engine is the glmer function in R which sits in the lme4 package. #' glmerSLMADS.assign fits a generalized linear mixed effects model (glme) - e.g. a logistic or #' Poisson regression model including both fixed and random effects - on data -#' from each single data source and saves the regression outcomes on the serveside. +#' from each single data source and saves the regression outcomes on the serverside. #' @param formula see help for ds.glmerSLMA #' @param offset see help for ds.glmerSLMA #' @param weights see help for ds.glmerSLMA diff --git a/R/hetcorDS.R b/R/hetcorDS.R index 3cf57366..d561ce30 100644 --- a/R/hetcorDS.R +++ b/R/hetcorDS.R @@ -1,7 +1,7 @@ #' #' @title Heterogeneous Correlation Matrix #' @description This function is based on the hetcor function from the R package \code{polycor}. -#' @details Computes a heterogenous correlation matrix, consisting of Pearson product-moment +#' @details 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. #' @param data the name of a data frame consisting of factors, ordered factors, logical variables, diff --git a/R/lexisDS2.R b/R/lexisDS2.R index e4c08117..d63989d2 100644 --- a/R/lexisDS2.R +++ b/R/lexisDS2.R @@ -3,7 +3,7 @@ #' @description The second serverside function called by ds.lexis. #' @details 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/R/lmerSLMADS.assign.R b/R/lmerSLMADS.assign.R index 526818a1..06b2bcd1 100644 --- a/R/lmerSLMADS.assign.R +++ b/R/lmerSLMADS.assign.R @@ -1,10 +1,10 @@ #' @title Fitting linear mixed effect models - serverside function -#' @description lmerSLMADS.assing is the same as lmerSLMADS2 which fits a linear +#' @description lmerSLMADS.assign is the same as lmerSLMADS2 which fits a linear #' mixed effects model (lme) per study and saves the outcomes in each study #' @details lmerSLMADS.assign is a serverside function called by ds.lmerSLMA on the clientside. #' The analytic work engine is the lmer function in R which sits in the lme4 package. #' lmerSLMADS.assign fits a linear mixed effects model (lme) including both fixed and random -#' effects - on data from each single data source and saves the regression outcomes on the serveside. +#' effects - on data from each single data source and saves the regression outcomes on the serverside. #' @param formula see help for ds.lmerSLMA #' @param offset see help for ds.lmerSLMA #' @param weights see help for ds.lmerSLMA diff --git a/R/meanDS.R b/R/meanDS.R index b186b4a9..59d1bc4e 100644 --- a/R/meanDS.R +++ b/R/meanDS.R @@ -1,5 +1,5 @@ #' -#' @title Computes statistical mean of a vectores +#' @title Computes statistical mean of a vector #' @description Calculates the mean value. #' @details if the length of input vector is less than the set filter #' a missing value is returned. diff --git a/R/metadataDS.R b/R/metadataDS.R index 3a478d48..a416ed61 100644 --- a/R/metadataDS.R +++ b/R/metadataDS.R @@ -4,7 +4,7 @@ #' @details The function returns the metadata, obtained from attributes function. #' @param x a string character, containing the name of the specified variable #' @return a list containing the metadata. The elements of the list will depend -#' on the meatadata available. +#' on the metadata available. #' @author Stuart Wheater, for DataSHIELD Development Team #' @export #' diff --git a/R/qlsplineDS.R b/R/qlsplineDS.R index 7b9d5e4b..3df267f8 100644 --- a/R/qlsplineDS.R +++ b/R/qlsplineDS.R @@ -15,7 +15,7 @@ #' probabilities directly (the vector is passed to argument probs of quantile). #' @param x the name of the input numeric variable #' @param q 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. +#' intervals along x or a vector of numbers in (0; 1) specifying the quantiles explicitly. #' @param na.rm logical, whether NA should be removed when calculating quantiles, passed #' to na.rm of quantile. Default set to TRUE. #' @param marginal logical, how to parametrize the spline, see Details diff --git a/R/repDS.R b/R/repDS.R index 4dd8a94f..61b4e3ea 100644 --- a/R/repDS.R +++ b/R/repDS.R @@ -41,7 +41,7 @@ #' help for " (see above). This parameter is usually fully defined by #' the argument in the call to \code{ds.rep} that itself calls \code{repDS}. #' @param length.out.transmit This argument fixes the length of -#' the output repetive sequence vector +#' the output repetitive sequence vector #' For behaviour see help for \code{ds.rep} and "details from native R #' help for " (see above). This parameter is usually fully defined by #' the argument in the call to \code{ds.rep} that itself calls \code{repDS}. diff --git a/R/rmDS.R b/R/rmDS.R index d7e4741d..04a3b1e1 100644 --- a/R/rmDS.R +++ b/R/rmDS.R @@ -9,7 +9,7 @@ #' fail because the effect of the function is to delete the object and so #' it would be impossible to write it anywhere. #' @param x.names.transmit, the names of the objects to be deleted converted -#' into transmissable form, a comma seperated list of character string. The +#' into transmissible form, a comma separated list of character string. The #' argument is specified via the argument of ds.rm #' @return the specified object is deleted from the serverside. If this #' is successful the message "Object successfully deleted" is returned diff --git a/R/table1DDS.R b/R/table1DDS.R index d73e3867..94bff957 100644 --- a/R/table1DDS.R +++ b/R/table1DDS.R @@ -5,7 +5,7 @@ #' @details 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. #' @param xvect a numerical vector with discrete values - usually a factor. #' @return a list which contains two elements: 'table', the 1-dimensional table and 'message' a message which diff --git a/R/tableDS.R b/R/tableDS.R index c9e9d621..c190ffc3 100644 --- a/R/tableDS.R +++ b/R/tableDS.R @@ -6,15 +6,15 @@ #' the table requested in the format specified by \code{ds.table}. For more #' information see help for \code{ds.table} in DataSHIELD and the \code{table} function #' in native R. -#' @param rvar.transmit is a character string (in inverted commas) specifiying the +#' @param rvar.transmit is a character string (in inverted commas) specifying the #' name of the variable defining the rows in all of the 2 dimensional #' tables that form the output. Fully specified by argument in \code{ds.table}. #' For more information see help for \code{ds.table} -#' @param cvar.transmit is a character string specifiying the +#' @param cvar.transmit is a character string specifying the #' name of the variable defining the columns in all of the 2 dimensional #' tables that form the output. Fully specified by argument in \code{ds.table}. #' For more information see help for \code{ds.table} -#' @param stvar.transmit is a character string specifiying the +#' @param stvar.transmit is a character string specifying the #' name of the variable that indexes the separate two dimensional #' tables in the output if the call specifies a 3 dimensional table. #' Fully specified by argument in \code{ds.table}. diff --git a/R/tableDS.assign.R b/R/tableDS.assign.R index 6dceba21..f7a05909 100644 --- a/R/tableDS.assign.R +++ b/R/tableDS.assign.R @@ -8,15 +8,15 @@ #' as an object named by the argument of \code{ds.table}. For more #' information see help for \code{ds.table} in DataSHIELD and the \code{table} function #' in native R. -#' @param rvar.transmit is a character string (in inverted commas) specifiying the +#' @param rvar.transmit is a character string (in inverted commas) specifying the #' name of the variable defining the rows in all of the 2 dimensional #' tables that form the output. Fully specified by argument in \code{ds.table}. #' For more information see help for \code{ds.table} -#' @param cvar.transmit is a character string specifiying the +#' @param cvar.transmit is a character string specifying the #' name of the variable defining the columns in all of the 2 dimensional #' tables that form the output. Fully specified by argument in \code{ds.table}. #' For more information see help for \code{ds.table} -#' @param stvar.transmit is a character string specifiying the +#' @param stvar.transmit is a character string specifying the #' name of the variable that indexes the separate two dimensional #' tables in the output if the call specifies a 3 dimensional table. #' Fully specified by argument in \code{ds.table}. diff --git a/R/tableDS2.R b/R/tableDS2.R index e1ab252a..3ea4803b 100644 --- a/R/tableDS2.R +++ b/R/tableDS2.R @@ -13,15 +13,15 @@ #' is nevertheless TRUE, the name for the serverside table object defaults #' to 'newObj'. Fully specified by argument in \code{ds.table}. #' For more information see help for \code{ds.table} -#' @param rvar.transmit is a character string (in inverted commas) specifiying the +#' @param rvar.transmit is a character string (in inverted commas) specifying the #' name of the variable defining the rows in all of the 2 dimensional #' tables that form the output. Fully specified by argument in \code{ds.table}. #' For more information see help for \code{ds.table} -#' @param cvar.transmit is a character string specifiying the +#' @param cvar.transmit is a character string specifying the #' name of the variable defining the columns in all of the 2 dimensional #' tables that form the output. Fully specified by argument in \code{ds.table}. #' For more information see help for \code{ds.table} -#' @param stvar.transmit is a character string specifiying the +#' @param stvar.transmit is a character string specifying the #' name of the variable that indexes the separate two dimensional #' tables in the output if the call specifies a 3 dimensional table. #' Fully specified by argument in \code{ds.table}. diff --git a/README.md b/README.md index cc983936..0e9eace1 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ For a full list of development branches, checkout https://github.com/datashield/ ## 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. +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 conjunction 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: @@ -66,6 +66,6 @@ Detailed instructions on how to install DataSHIELD are at https://wiki.datashiel 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: + 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. . From 16942f7b8b3ebb4165dc71a435df6e6dea3390ec Mon Sep 17 00:00:00 2001 From: Roberto Villegas-Diaz Date: Wed, 20 Aug 2025 16:02:22 +0100 Subject: [PATCH 2/3] Correct citations --- inst/CITATION | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/inst/CITATION b/inst/CITATION index 0d81fdd6..cf856ce6 100644 --- a/inst/CITATION +++ b/inst/CITATION @@ -23,7 +23,7 @@ bibentry( person("Lisette", "Giepmans"), person("Susan E", "Wallace"), person("Isabelle", "Budin-Lj{\\o}sne"), - person("Carsten", "{Oliver Schmidt}"), + person("Carsten O.", "Schmidt"), person("Paolo", "Boffetta"), person("Mathieu", "Boniol"), person("Maria", "Bota"), @@ -68,13 +68,13 @@ bibentry( title = "{DataSHIELD – New Directions and Dimensions}", author = c( person("Rebecca C.", "Wilson"), - person("Oliver", "W. Butters"), + person("Oliver W.", "Butters"), person("Demetris", "Avraam"), person("James", "Baker"), person("Jonathan A.", "Tedds"), person("Andrew", "Turner"), person("Madeleine", "Murtagh"), - person("Paul", "R. Burton") + person("Paul R.", "Burton") ), journal = "Data Science Journal", year = "2017", @@ -118,10 +118,10 @@ bibentry( person("Angela", "{Pinot de Moira}"), person("Florian", "Schwarz"), person("Katrine", "Strandberg-Larsen"), - person("Morris AvSwertz"), + person("Morris A", "Swertz"), person("Marieke", "Welten"), person("Stuart", "Wheater"), - person("Paul", "Burton") + person("Paul R", "Burton") ), journal = "Bioinformatics Advances", year = "2024", From 675bc9828f0d3c22b2e6bc9f24fb0d99138704e4 Mon Sep 17 00:00:00 2001 From: Roberto Villegas-Diaz Date: Wed, 20 Aug 2025 16:05:51 +0100 Subject: [PATCH 3/3] New build --- docs/authors.html | 12 ++++++------ docs/index.html | 12 ++++++------ docs/pkgdown.yml | 4 ++-- docs/reference/asDataMatrixDS.html | 2 +- docs/reference/checkNegValueDS.html | 2 +- docs/reference/densityGridDS.html | 4 ++-- docs/reference/dmtC2SDS.html | 4 ++-- docs/reference/gamlssDS.html | 4 ++-- docs/reference/glmerSLMADS.assign.html | 2 +- docs/reference/hetcorDS.html | 2 +- docs/reference/index.html | 4 ++-- docs/reference/lexisDS2.html | 2 +- docs/reference/lmerSLMADS.assign.html | 6 +++--- docs/reference/meanDS.html | 4 ++-- docs/reference/metadataDS.html | 2 +- docs/reference/qlsplineDS.html | 2 +- docs/reference/repDS.html | 2 +- docs/reference/rmDS.html | 2 +- docs/reference/table1DDS.html | 2 +- docs/reference/tableDS.assign.html | 6 +++--- docs/reference/tableDS.html | 6 +++--- docs/reference/tableDS2.html | 6 +++--- man/asDataMatrixDS.Rd | 2 +- man/checkNegValueDS.Rd | 2 +- man/densityGridDS.Rd | 2 +- man/dmtC2SDS.Rd | 4 ++-- man/gamlssDS.Rd | 2 +- man/glmerSLMADS.assign.Rd | 2 +- man/hetcorDS.Rd | 2 +- man/lexisDS2.Rd | 2 +- man/lmerSLMADS.assign.Rd | 4 ++-- man/meanDS.Rd | 2 +- man/metadataDS.Rd | 2 +- man/qlsplineDS.Rd | 2 +- man/repDS.Rd | 2 +- man/rmDS.Rd | 2 +- man/table1DDS.Rd | 2 +- man/tableDS.Rd | 6 +++--- man/tableDS.assign.Rd | 6 +++--- man/tableDS2.Rd | 6 +++--- 40 files changed, 72 insertions(+), 72 deletions(-) diff --git a/docs/authors.html b/docs/authors.html index 7008d201..ce342a9f 100644 --- a/docs/authors.html +++ b/docs/authors.html @@ -109,14 +109,14 @@

Citation

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

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, 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},
+  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 O. 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},
@@ -124,14 +124,14 @@ 

Citation

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

Wilson R, Butters O, Avraam D, Baker J, Tedds J, Turner A, Murtagh M, 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}},
+  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},
@@ -139,14 +139,14 @@ 

Citation

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

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. 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},
+  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 A Swertz and Marieke Welten and Stuart Wheater and Paul R Burton},
   journal = {Bioinformatics Advances},
   year = {2024},
   volume = {5},
diff --git a/docs/index.html b/docs/index.html
index 1af30cbf..18cfb110 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -79,27 +79,27 @@ 

Installation

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.

+

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 conjunction 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:

- + - + - + - + @@ -112,7 +112,7 @@

Referenceshttps://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.

+

[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 3d3f1b22..50a63ee4 100644 --- a/docs/pkgdown.yml +++ b/docs/pkgdown.yml @@ -1,5 +1,5 @@ -pandoc: 3.1.3 +pandoc: '3.4' pkgdown: 2.1.3 pkgdown_sha: ~ articles: {} -last_built: 2025-08-18T13:34Z +last_built: 2025-08-20T15:00Z diff --git a/docs/reference/asDataMatrixDS.html b/docs/reference/asDataMatrixDS.html index 6aa65f1e..6129cec8 100644 --- a/docs/reference/asDataMatrixDS.html +++ b/docs/reference/asDataMatrixDS.html @@ -70,7 +70,7 @@

Value

Details

This assign function is based on the native R function data.matrix If applied to a data.frame, the native R function as.matrix -coverts all columns into character class. In contrast, if applied to +converts all columns into character class. In contrast, if applied to a data.frame the native R function data.matrix converts the data.frame to a matrix but maintains all data columns in their original class

diff --git a/docs/reference/checkNegValueDS.html b/docs/reference/checkNegValueDS.html index 38484630..b40e7520 100644 --- a/docs/reference/checkNegValueDS.html +++ b/docs/reference/checkNegValueDS.html @@ -61,7 +61,7 @@

Value

Details

-

if a user sets the parameter 'weights' on the client site function ds.glm this +

if a user sets the parameter 'weights' on the client side function ds.glm this server side function is called to verify that the 'weights' vector does not have negative values because no negative are allowed in weights.

diff --git a/docs/reference/densityGridDS.html b/docs/reference/densityGridDS.html index 51f0a6c8..6bd9d93d 100644 --- a/docs/reference/densityGridDS.html +++ b/docs/reference/densityGridDS.html @@ -1,5 +1,5 @@ -Generates a density grid with or without a priori defined limits — densityGridDS • dsBaseGenerates a density grid with or without a priori defined limits — densityGridDS • dsBase @@ -40,7 +40,7 @@

Generates a density grid with or without a priori defined limits

-

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.

diff --git a/docs/reference/dmtC2SDS.html b/docs/reference/dmtC2SDS.html index f76845d2..27c7f867 100644 --- a/docs/reference/dmtC2SDS.html +++ b/docs/reference/dmtC2SDS.html @@ -97,13 +97,13 @@

Arguments

colnames.transmit
-

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.

colclass.transmit
-

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 an aggregate function called by ds.galmss — gamlssDS • dsBase

diff --git a/docs/reference/glmerSLMADS.assign.html b/docs/reference/glmerSLMADS.assign.html index a73e9bed..489acdd4 100644 --- a/docs/reference/glmerSLMADS.assign.html +++ b/docs/reference/glmerSLMADS.assign.html @@ -129,7 +129,7 @@

Details

The analytic work engine is the glmer function in R which sits in the lme4 package. glmerSLMADS.assign fits a generalized linear mixed effects model (glme) - e.g. a logistic or Poisson regression model including both fixed and random effects - on data -from each single data source and saves the regression outcomes on the serveside.

+from each single data source and saves the regression outcomes on the serverside.

Author

diff --git a/docs/reference/hetcorDS.html b/docs/reference/hetcorDS.html index 990d44a9..d12ec828 100644 --- a/docs/reference/hetcorDS.html +++ b/docs/reference/hetcorDS.html @@ -93,7 +93,7 @@

Value

Details

-

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

diff --git a/docs/reference/index.html b/docs/reference/index.html index 78275f79..7c6dd126 100644 --- a/docs/reference/index.html +++ b/docs/reference/index.html @@ -208,7 +208,7 @@

All functions

- + @@ -372,7 +372,7 @@

All functions

- + diff --git a/docs/reference/lexisDS2.html b/docs/reference/lexisDS2.html index dd0bcb45..23318275 100644 --- a/docs/reference/lexisDS2.html +++ b/docs/reference/lexisDS2.html @@ -111,7 +111,7 @@

Value

Details

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 @@ -Fitting linear mixed effect models - serverside function — lmerSLMADS.assign • dsBaseFitting linear mixed effect models - serverside function — lmerSLMADS.assign • dsBaseComputes statistical mean of a vectores — meanDS • dsBaseComputes statistical mean of a vector — meanDS • dsBase @@ -34,7 +34,7 @@

diff --git a/docs/reference/metadataDS.html b/docs/reference/metadataDS.html index ab6418f8..34504ffa 100644 --- a/docs/reference/metadataDS.html +++ b/docs/reference/metadataDS.html @@ -58,7 +58,7 @@

Arguments

Value

a list containing the metadata. The elements of the list will depend -on the meatadata available.

+on the metadata available.

Details

diff --git a/docs/reference/qlsplineDS.html b/docs/reference/qlsplineDS.html index a5d91f0f..8954d3f2 100644 --- a/docs/reference/qlsplineDS.html +++ b/docs/reference/qlsplineDS.html @@ -63,7 +63,7 @@

Arguments

q

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.

+intervals along x or a vector of numbers in (0; 1) specifying the quantiles explicitly.

na.rm
diff --git a/docs/reference/repDS.html b/docs/reference/repDS.html index 0896a168..95c45702 100644 --- a/docs/reference/repDS.html +++ b/docs/reference/repDS.html @@ -87,7 +87,7 @@

Arguments

length.out.transmit

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.

diff --git a/docs/reference/rmDS.html b/docs/reference/rmDS.html index 19b20773..2c85bbbd 100644 --- a/docs/reference/rmDS.html +++ b/docs/reference/rmDS.html @@ -53,7 +53,7 @@

Arguments

x.names.transmit,

the names of the objects to be deleted converted -into transmissable form, a comma seperated list of character string. The +into transmissible form, a comma separated list of character string. The argument is specified via the <x.names> argument of ds.rm

diff --git a/docs/reference/table1DDS.html b/docs/reference/table1DDS.html index e1dd9566..5dc7a17a 100644 --- a/docs/reference/table1DDS.html +++ b/docs/reference/table1DDS.html @@ -67,7 +67,7 @@

Details

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.

diff --git a/docs/reference/tableDS.assign.html b/docs/reference/tableDS.assign.html index a5abb4fa..e71aae2b 100644 --- a/docs/reference/tableDS.assign.html +++ b/docs/reference/tableDS.assign.html @@ -63,21 +63,21 @@

Arguments

rvar.transmit
-

is a character string (in inverted commas) specifiying the +

is a character string (in inverted commas) specifying the name of the variable defining the rows in all of the 2 dimensional tables that form the output. Fully specified by <rvar> argument in ds.table. For more information see help for ds.table

cvar.transmit
-

is a character string specifiying the +

is a character string specifying the name of the variable defining the columns in all of the 2 dimensional tables that form the output. Fully specified by <cvar> argument in ds.table. For more information see help for ds.table

stvar.transmit
-

is a character string specifiying the +

is a character string specifying the name of the variable that indexes the separate two dimensional tables in the output if the call specifies a 3 dimensional table. Fully specified by <stvar> argument in ds.table. diff --git a/docs/reference/tableDS.html b/docs/reference/tableDS.html index 2026c164..dcfc8cc7 100644 --- a/docs/reference/tableDS.html +++ b/docs/reference/tableDS.html @@ -64,21 +64,21 @@

Arguments

rvar.transmit
-

is a character string (in inverted commas) specifiying the +

is a character string (in inverted commas) specifying the name of the variable defining the rows in all of the 2 dimensional tables that form the output. Fully specified by <rvar> argument in ds.table. For more information see help for ds.table

cvar.transmit
-

is a character string specifiying the +

is a character string specifying the name of the variable defining the columns in all of the 2 dimensional tables that form the output. Fully specified by <cvar> argument in ds.table. For more information see help for ds.table

stvar.transmit
-

is a character string specifiying the +

is a character string specifying the name of the variable that indexes the separate two dimensional tables in the output if the call specifies a 3 dimensional table. Fully specified by <stvar> argument in ds.table. diff --git a/docs/reference/tableDS2.html b/docs/reference/tableDS2.html index 8b777e9f..2fe4186d 100644 --- a/docs/reference/tableDS2.html +++ b/docs/reference/tableDS2.html @@ -63,21 +63,21 @@

Arguments

rvar.transmit
-

is a character string (in inverted commas) specifiying the +

is a character string (in inverted commas) specifying the name of the variable defining the rows in all of the 2 dimensional tables that form the output. Fully specified by <rvar> argument in ds.table. For more information see help for ds.table

cvar.transmit
-

is a character string specifiying the +

is a character string specifying the name of the variable defining the columns in all of the 2 dimensional tables that form the output. Fully specified by <cvar> argument in ds.table. For more information see help for ds.table

stvar.transmit
-

is a character string specifiying the +

is a character string specifying the name of the variable that indexes the separate two dimensional tables in the output if the call specifies a 3 dimensional table. Fully specified by <stvar> argument in ds.table. diff --git a/man/asDataMatrixDS.Rd b/man/asDataMatrixDS.Rd index 1a87b0d2..3170e9af 100644 --- a/man/asDataMatrixDS.Rd +++ b/man/asDataMatrixDS.Rd @@ -24,7 +24,7 @@ class for all columns in data.frames. \details{ This assign function is based on the native R function \code{data.matrix} If applied to a data.frame, the native R function \code{as.matrix} -coverts all columns into character class. In contrast, if applied to +converts all columns into character class. In contrast, if applied to a data.frame the native R function \code{data.matrix} converts the data.frame to a matrix but maintains all data columns in their original class diff --git a/man/checkNegValueDS.Rd b/man/checkNegValueDS.Rd index e06e28ef..a811eaaf 100644 --- a/man/checkNegValueDS.Rd +++ b/man/checkNegValueDS.Rd @@ -16,7 +16,7 @@ a boolean; TRUE if the vector has one or more negative values and FALSE otherwis this function is only called by the client function \code{ds.glm}. } \details{ -if a user sets the parameter 'weights' on the client site function \code{ds.glm} this +if a user sets the parameter 'weights' on the client side function \code{ds.glm} this server side function is called to verify that the 'weights' vector does not have negative values because no negative are allowed in weights. } diff --git a/man/densityGridDS.Rd b/man/densityGridDS.Rd index ea18a3b0..2b254acf 100644 --- a/man/densityGridDS.Rd +++ b/man/densityGridDS.Rd @@ -38,7 +38,7 @@ If \code{limits} is set to "TRUE", limits defined by x.min, x.max, y.min and y.m a grid density matrix } \description{ -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. } \details{ Invalid cells (cells with count < to the set filter value for the minimum allowed diff --git a/man/dmtC2SDS.Rd b/man/dmtC2SDS.Rd index 102d3859..524f82f0 100644 --- a/man/dmtC2SDS.Rd +++ b/man/dmtC2SDS.Rd @@ -40,11 +40,11 @@ the clientside DMT to be transferred.} Fixed by the clientside function as equal to the number of columns in the clientside DMT to be transferred.} -\item{colnames.transmit}{a parser-transmissable vector specifying the name of each column +\item{colnames.transmit}{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.} -\item{colclass.transmit}{a parser-transmissable vector specifying the class of the +\item{colclass.transmit}{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/man/gamlssDS.Rd b/man/gamlssDS.Rd index f4cb1568..218eb4ac 100644 --- a/man/gamlssDS.Rd +++ b/man/gamlssDS.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/gamlssDS.R \name{gamlssDS} \alias{gamlssDS} -\title{gamlssDS an aggregate function called by ds.galmss} +\title{gamlssDS an aggregate function called by ds.gamlss} \usage{ gamlssDS( formula = formula, diff --git a/man/glmerSLMADS.assign.Rd b/man/glmerSLMADS.assign.Rd index f40c8f05..6db1196d 100644 --- a/man/glmerSLMADS.assign.Rd +++ b/man/glmerSLMADS.assign.Rd @@ -63,7 +63,7 @@ glmerSLMADS.assign is a serverside function called by ds.glmerSLMA on the client The analytic work engine is the glmer function in R which sits in the lme4 package. glmerSLMADS.assign fits a generalized linear mixed effects model (glme) - e.g. a logistic or Poisson regression model including both fixed and random effects - on data -from each single data source and saves the regression outcomes on the serveside. +from each single data source and saves the regression outcomes on the serverside. } \author{ Demetris Avraam for DataSHIELD Development Team diff --git a/man/hetcorDS.Rd b/man/hetcorDS.Rd index 3af57873..2745ce65 100644 --- a/man/hetcorDS.Rd +++ b/man/hetcorDS.Rd @@ -38,7 +38,7 @@ FALSE for two-step estimates. This function is based on the hetcor function from the R package \code{polycor}. } \details{ -Computes 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. } diff --git a/man/lexisDS2.Rd b/man/lexisDS2.Rd index 9b943bb1..51ca6851 100644 --- a/man/lexisDS2.Rd +++ b/man/lexisDS2.Rd @@ -52,7 +52,7 @@ The second serverside function called by ds.lexis. \details{ 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/man/lmerSLMADS.assign.Rd b/man/lmerSLMADS.assign.Rd index eb8c34bd..cc2ff9f0 100644 --- a/man/lmerSLMADS.assign.Rd +++ b/man/lmerSLMADS.assign.Rd @@ -41,14 +41,14 @@ writes lmerMod object summarising the fitted model to the serverside. For more detailed information see help for ds.lmerSLMA. } \description{ -lmerSLMADS.assing is the same as lmerSLMADS2 which fits a linear +lmerSLMADS.assign is the same as lmerSLMADS2 which fits a linear mixed effects model (lme) per study and saves the outcomes in each study } \details{ lmerSLMADS.assign is a serverside function called by ds.lmerSLMA on the clientside. The analytic work engine is the lmer function in R which sits in the lme4 package. lmerSLMADS.assign fits a linear mixed effects model (lme) including both fixed and random -effects - on data from each single data source and saves the regression outcomes on the serveside. +effects - on data from each single data source and saves the regression outcomes on the serverside. } \author{ TDemetris Avraam for DataSHIELD Development Team diff --git a/man/meanDS.Rd b/man/meanDS.Rd index 94e1d7c8..6802ad58 100644 --- a/man/meanDS.Rd +++ b/man/meanDS.Rd @@ -2,7 +2,7 @@ % Please edit documentation in R/meanDS.R \name{meanDS} \alias{meanDS} -\title{Computes statistical mean of a vectores} +\title{Computes statistical mean of a vector} \usage{ meanDS(xvect) } diff --git a/man/metadataDS.Rd b/man/metadataDS.Rd index 0c636b46..f7749090 100644 --- a/man/metadataDS.Rd +++ b/man/metadataDS.Rd @@ -11,7 +11,7 @@ metadataDS(x) } \value{ a list containing the metadata. The elements of the list will depend -on the meatadata available. +on the metadata available. } \description{ This function returns metadata, if any, about specified variable. diff --git a/man/qlsplineDS.Rd b/man/qlsplineDS.Rd index cdf88ddd..aa14326a 100644 --- a/man/qlsplineDS.Rd +++ b/man/qlsplineDS.Rd @@ -10,7 +10,7 @@ qlsplineDS(x = x, q = q, na.rm = TRUE, marginal = FALSE, names = NULL) \item{x}{the name of the input numeric variable} \item{q}{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.} +intervals along x or a vector of numbers in (0; 1) specifying the quantiles explicitly.} \item{na.rm}{logical, whether NA should be removed when calculating quantiles, passed to na.rm of quantile. Default set to TRUE.} diff --git a/man/repDS.Rd b/man/repDS.Rd index 5d410418..306e2aec 100644 --- a/man/repDS.Rd +++ b/man/repDS.Rd @@ -30,7 +30,7 @@ help for " (see above). This parameter is usually fully defined by the argument in the call to \code{ds.rep} that itself calls \code{repDS}.} \item{length.out.transmit}{This argument fixes the length of -the output repetive sequence vector +the output repetitive sequence vector For behaviour see help for \code{ds.rep} and "details from native R help for " (see above). This parameter is usually fully defined by the argument in the call to \code{ds.rep} that itself calls \code{repDS}.} diff --git a/man/rmDS.Rd b/man/rmDS.Rd index 18d85255..f4d13286 100644 --- a/man/rmDS.Rd +++ b/man/rmDS.Rd @@ -8,7 +8,7 @@ rmDS(x.names.transmit) } \arguments{ \item{x.names.transmit, }{the names of the objects to be deleted converted -into transmissable form, a comma seperated list of character string. The +into transmissible form, a comma separated list of character string. The argument is specified via the argument of ds.rm} } \value{ diff --git a/man/table1DDS.Rd b/man/table1DDS.Rd index 950ff239..98bb8750 100644 --- a/man/table1DDS.Rd +++ b/man/table1DDS.Rd @@ -21,7 +21,7 @@ This function generates a 1-dimensional table where potentially disclosive cells 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. } \author{ diff --git a/man/tableDS.Rd b/man/tableDS.Rd index a6ac5a45..752eb815 100644 --- a/man/tableDS.Rd +++ b/man/tableDS.Rd @@ -18,17 +18,17 @@ tableDS( ) } \arguments{ -\item{rvar.transmit}{is a character string (in inverted commas) specifiying the +\item{rvar.transmit}{is a character string (in inverted commas) specifying the name of the variable defining the rows in all of the 2 dimensional tables that form the output. Fully specified by argument in \code{ds.table}. For more information see help for \code{ds.table}} -\item{cvar.transmit}{is a character string specifiying the +\item{cvar.transmit}{is a character string specifying the name of the variable defining the columns in all of the 2 dimensional tables that form the output. Fully specified by argument in \code{ds.table}. For more information see help for \code{ds.table}} -\item{stvar.transmit}{is a character string specifiying the +\item{stvar.transmit}{is a character string specifying the name of the variable that indexes the separate two dimensional tables in the output if the call specifies a 3 dimensional table. Fully specified by argument in \code{ds.table}. diff --git a/man/tableDS.assign.Rd b/man/tableDS.assign.Rd index 7a79e36a..8214ab3d 100644 --- a/man/tableDS.assign.Rd +++ b/man/tableDS.assign.Rd @@ -17,17 +17,17 @@ tableDS.assign( ) } \arguments{ -\item{rvar.transmit}{is a character string (in inverted commas) specifiying the +\item{rvar.transmit}{is a character string (in inverted commas) specifying the name of the variable defining the rows in all of the 2 dimensional tables that form the output. Fully specified by argument in \code{ds.table}. For more information see help for \code{ds.table}} -\item{cvar.transmit}{is a character string specifiying the +\item{cvar.transmit}{is a character string specifying the name of the variable defining the columns in all of the 2 dimensional tables that form the output. Fully specified by argument in \code{ds.table}. For more information see help for \code{ds.table}} -\item{stvar.transmit}{is a character string specifiying the +\item{stvar.transmit}{is a character string specifying the name of the variable that indexes the separate two dimensional tables in the output if the call specifies a 3 dimensional table. Fully specified by argument in \code{ds.table}. diff --git a/man/tableDS2.Rd b/man/tableDS2.Rd index 38f6c5e8..86e27027 100644 --- a/man/tableDS2.Rd +++ b/man/tableDS2.Rd @@ -15,17 +15,17 @@ is nevertheless TRUE, the name for the serverside table object defaults to 'newObj'. Fully specified by argument in \code{ds.table}. For more information see help for \code{ds.table}} -\item{rvar.transmit}{is a character string (in inverted commas) specifiying the +\item{rvar.transmit}{is a character string (in inverted commas) specifying the name of the variable defining the rows in all of the 2 dimensional tables that form the output. Fully specified by argument in \code{ds.table}. For more information see help for \code{ds.table}} -\item{cvar.transmit}{is a character string specifiying the +\item{cvar.transmit}{is a character string specifying the name of the variable defining the columns in all of the 2 dimensional tables that form the output. Fully specified by argument in \code{ds.table}. For more information see help for \code{ds.table}} -\item{stvar.transmit}{is a character string specifiying the +\item{stvar.transmit}{is a character string specifying the name of the variable that indexes the separate two dimensional tables in the output if the call specifies a 3 dimensional table. Fully specified by argument in \code{ds.table}.

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.

gamlssDS()

gamlssDS an aggregate function called by ds.galmss

gamlssDS an aggregate function called by ds.gamlss

getWGSRDS()

meanDS()

Computes statistical mean of a vectores

Computes statistical mean of a vector

meanSdGpDS()