Code Monkey home page Code Monkey logo

comsldpsy-1's Introduction

comsldpsy

This repository contains a reproducible research compendium for our paper:

Visser, L., Kalmar, J., Görgen, R., Linkersdörfer, J., Rothe, J., Hasselhorn, M., & Schulte-Körne, G. (submitted). Comorbidities between specific learning disorders and psychopathology: a study with elementary school children in Germany.

How to cite

Please cite this compendium as:

Visser, L., Kalmar, J., Görgen, R., Linkersdörfer, J., Rothe, J., Hasselhorn, M., & Schulte-Körne, G., (2018). Compendium of R code and data for ‘Comorbidities between specific learning disorders and psychopathology: a study with elementary school children in Germany’. Accessed 10 Dec 2018. Online at http://doi.org/10.17605/OSF.IO/9MXP2

Contents

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 3 subfolders with the following contents
    • data/: the raw data
    • templates/: the Microsoft word template used to prepare the manuscript
    • manuscript/: the manuscript as submitted

How to download or install

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, 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:

    • Click Binder to launch an interactive RStudio session in your web browser.

Licenses

Text and figures : CC-BY-4.0

Code : See the DESCRIPTION file

Data : CC-0 attribution requested in reuse

comsldpsy-1's People

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.