The dsGamlss package is a DataSHIELD
server-side package that includes the server-side functions to fit
Generalized Additive Models for Location, Scale and Shape (GAMLSS) [1]
using DataSHIELD. It is based on the original
gamlss implementation [1]
and the dsBase package [2].
DataSHIELD is a software infrastructure which allows you to do
non-disclosive federated analysis on sensitive data. The DataSHIELD
website 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 dsGamlss
package needs to be used in conjunction with the
dsGamlssClient package -
trying to use one without the other makes no sense. Detailed
instructions on how to install DataSHIELD can be found at the
DataSHIELD Wiki. Discussion and help
with using DataSHIELD can be obtained from the DataSHIELD
Forum
If you want to use the sever-less DataSHIELD implementation
DSLite [3], that is used
in the example, you can install the dsGamlss package on your local
machine from GitHub with:
# install.packages("devtools")
devtools::install_github("bips-hb/dsGamlss")If you are working with real
Armadillo or
Opal DataSHIELD servers, the
dsGamlss package must be installed on the DataSHIELD servers instead.
Instructions on how to install a package on an Armadillo or Opal
DataSHIELD server can be found in the Data Manager
Section
at the DataSHIELD Wiki.
Direct usage of the functions in this package is not recommended.
Therefore, no example is provided. Instead, you should use the functions
from the corresponding client-side package
dsGamlssClient to fit
GAMLSS models with DataSHIELD and the dsGamlssClient package provides
examples for that.
- Rigby RA, Stasinopoulos DM. Generalized additive models for location, scale and shape. Journal of the Royal Statistical Society: Series C (Applied Statistics). 2005;54(3):507-54.
- DataSHIELD Developers (2023). dsBaseClient: DataSHIELD Client Functions. R package version 6.3.0.
- Marcon Y (2022). DSLite: ‘DataSHIELD’ Implementation on Local Datasets. R package version 1.4.0, https://CRAN.R-project.org/package=DSLite.