This is a tutorial outlining how to develop functions for DataSHIELD. DataSHIELD is released under a GPL3 license, and we will accept contributions of new functionality to be included in our software base giving due credit to DataSHIELD function/package authors. New developments are done on your own computer, checks are made and then these are pushed to your branch on Github.
DataSHIELD developers are expected to have some basic knowledge on how to create R functions as well as sound understanding of the statistical methods being implemented. |
Install R Studio
Configuring R StudioR Version
Sync with GitOnce Git is installed you need to activate it in R Studio:
Setting up default R libraries
Installing developer dependancies
|
libssl-dev, libgit2-dev, libxml2-utils, libxml2-dev
Rtools
devtools
and roxygen by running the below command in R or Rstudio.install.packages("devtools", dependencies = TRUE) install.packages("roxygen2", dependencies = TRUE) install.packages("Rtools", dependencies = TRUE) |
libssl-dev, libgit2-dev, libxml2-utils, libxml2-dev
Rtools
devtools
and roxygen by running the below command in R or Rstudio.install.packages("devtools", dependencies = TRUE) install.packages("roxygen2", dependencies = TRUE) install.packages("Rtools", dependencies = TRUE) |
It is important to ensure your computer is fully set up before embarking into any developments. Otherwise you are most likely going to face some errors at some stage and the support team might not be able to help because it is often very difficult to identify the sources of errors originating from wrong settings. If you faced with difficulties in getting set up please contact the support team at datashield@newcastle.ac.uk |
Welcome to DataSHIELD development!