Author: Lukas Huber https://orcid.org/0000-0001-5443-0290
This template can serve as common starting point for traceable analyses in observational clinical research.
The projects created with this template should be:
The user should utilize R and Tidyverse.
The figure shows the main elements one may and should use to address the main needs of technical setup, in order to get a project up and running, follow the Getting started guide
This template sets up a reproducible, aimed at FAIR environment for data science. It is possible to use it in different levels of reproducibility. It uses Docker, R, RMarkdown, Git, drake, mandrake, pkgdown, roxygen, roxytest and Github Actions.
The template is aimed at collaborators with technical and non-technical backgrounds, while the minimum requirement to run it, is having docker installed.
In order to document the Clinical Setting - this template recommends to follow the STROBE Statement and fill out the following items first:
The project template recommends following a defined process with phases plan, action, validation, organization and curation.
pull_request_template.md file to allow collaborators for a standard approach in approaching the merge requests.
Description of data provenance and history goes here.
The template is configured to store data within the code repository in the folder
The code of this repsoitory resides in a git-version controlled repository and utilizes tests with testthat and roxytest.
Good Code Style should be enforced using e.g.
In order to reproduce the results from the template and example scenarios, you need to have docker installed on your machine.
First get the image built within this repository, as it contains all dependencies and elements used within this work:
docker pull docker.io/g4challenge/repro-fair-neuro-ds-template
After the download is completed, the container of the image can be started using:
docker run -e PASSWORD=12345 -p 8787:8787 docker.io/g4challenge/repro-fair-neuro-ds-template
Then open your browser and enter the address http://localhost:8787. Use user
rstudio and the set PASSWORD (e.g.
12345) to log into the environment.
Open the project and project file (red rectangle) to launch the project.
The statistical methods are denoted as drake specification. The analysis is traceable and computationally reproducable.
The main specification is found in drake_spec
The run of
vignettes/scenario_1.Rmd - can be tested with the output and history.
Thereby, it is testable, if the results, the versioned drake history, and a new run result in the same results.
The research results have associated generated metadata, which can be displayed as HTML or are available as JSON.
Further, the results are archived and stored as zip on Zenodo:
Description of data structures, documentation, requirements and publications.
Elements the user should be familiar with:
Alternatives and extensions: