The current analysis tutorials only represent a small proportion of the possible analyses with DataSHIELD. We welcome all contributions to fill gaps in the current portfolio! However, to ensure consistency and ease-of-use we would request you follow the following guidelines.
Analysis tutorials should be written in markdown. One possible flow is to write tutorials in RMarkdown, convert these to markdown (using the render
function from the RMarkdown
package) and then upload these.
Two demo servers have been set up and are freely available to use. Please use the login script here to use these servers in your tutorials.
We have made available various example datasets, listed here. If possible, please use one of these datasets as an example. The advanatage of these datasets is that because they are freely accessible and do not contain sensitive data, it is possible to compare the values and output from DataSHIELD analysis with the original values. If you need to include other data files which are not currently available in these servers, please contact support@molgenis.org and we can assist you with uploading additional data.
All tutorials should be self-contained and runnable. Before uploading please check that all code-blocks run correctly using the demo servers described above.