This repository contains a reproducible research compendium for our paper:
Visser, L., Kalmar, J., Linkersdörfer, J., Görgen, R., Rothe, J., Hasselhorn, M., & Schulte-Körne, G. (2020). Comorbidities between specific learning disorders and psychopathology in elementary school children in Germany. Frontiers in Psychiatry. http://doi.org/10.3389/fpsyt.2020.00292
Please cite this compendium as:
Visser, L., Kalmar, J., Linkersdörfer, J., Görgen, R., Rothe, J., Hasselhorn, M., & Schulte-Körne, G., (2020). Compendium of R code and data for ‘Comorbidities between specific learning disorders and psychopathology in elementary school children in Germany’. Accessed 13 Apr 2020. Online at http://doi.org/10.17605/OSF.IO/9MXP2
The compendium contains all data, code, and text associated with the paper. It is organized as follows:
- The
R/
directory contains all the R code. - The
inst/analysis_dir/analysis/
directory contains 4 subfolders with the following contentsdata/
: the raw datafigures/
: the figures used in the manuscriptmanuscript/
: the manuscript as accepted by the journaltemplates/
: the Microsoft word template used to prepare the manuscript
There are several ways to use the compendium’s contents and reproduce the analysis:
-
Download the compendium as a zip archive from this GitHub repository or a registered/frozen version from the associated OSF project (click on “GitHub: …”, then select “Download as zip”).
- After unpacking the downloaded zip archive, you can explore the files on your computer.
-
Install the compendium as an R package from GitHub using the
devtools
package:install.packages("devtools") devtools::install_github("idea-labs/comsldpsy")
- This will install the R package locally including all its dependencies.
- The package includes functions to
- check the analysis for consistency
- inspect the analysis pipeline and intermediate results
- reproduce the analysis results on the user’s computer
- For more details on how to use the package and its functions, see here.
-
Reproduce the analysis locally inside a Docker container. This allows to replicate the exact computational environment used by the authors. The compendium includes a Dockerfile that specifies how to build a Docker image that contains all the software dependencies needed to run the code and also includes the compendium’s R package, ready to use. After installing Docker (needs administrator privileges), one can simply download the image and run the container using:
docker run -p 8888:8888 idealabsffm/comsldpsy
- This command will print a URL to the terminal.
- Copy this URL and paste it into a web browser.
- This will open a Jupyter Notebook.
- Start an interactive RStudio session in the browser by selecting:
-
Reproduce the analysis in the cloud without having to install any software. The same Docker container replicating the computational environment used by the authors can be run using BinderHub on mybinder.org:
Text and figures : CC-BY-4.0
Code : See the DESCRIPTION file
Data : CC-0 attribution requested in reuse