For detailed information: 
 The British Ecological Society (2017). A guide to reproducible code in ecology and evolution. 
  Report available here


Content of open analysis code

The open analysis code provides all conducted analysis steps including data processing, statistical analysis and other code (simulations, etc.). The code is commented in the code files to make it understandable and transparent and reproduceable to others.

Criteria to make data analysis reproducible:
  • data & metadata are available
  • code & usage are transparent
  • code is installable

  • runtime environment is reproduceable


Detailed aspects to create reproduceable code

To make open analysis code reproduceable the following aspects should be considered in detail:

  • Choosing a coherent and informative naming system for the folders, files and projects.
  • Choosing a consistent coding and consistent script style.
  • Always comment the analysis code.
  • Recording the used packages and software.
  • Publishing the open analysis code along the belonging open data on an open access online-repository.

In addition, following aspects can be considered to be set up in addition to the analysis code:

  • Considering a version control repository to keep track of the changes made in the code over time.
  • Providing a README file on the respiratory to describe the project and details on the workflow around the project files.
  • Attaching a LICENSE file, which is an explicit statement that grants certain uses of work, defining how people are allowed to reuse the analysis code. How version control, README file and LICENSE file can be set up: The British Ecological Society (2017). A guide to reproducible code in ecology and evolution. Report available here

Ethical barriers

To protect privacy, always be aware to anonymize your data and code. All information about ethical barriers in open data and code are given in the section open data of this moodle course.

@ students: please, always talk to your responsible professor, lecturer and/ or supervisor about ethical barriers in open data and open code. Do not provide data or code online without talking to your responsible professor, lecturer and/ or supervisor!


Check your code for reproducibility


Open Science Initiative der WWU Münster (2018). Informations- und Lösungsmodule: Reproducible Codes. Adapted from https://osf.io/zc24b/


Examples

Note: These examples are intentionally kept simple to demonstrate the basics of creating reproduceable code.

1. How a simple and informative file structure for folders and files can look like:


Fig 2. Linking analysis associated files (e.g. R scripts with functions) and outputs (generated figures) through the use of consistent naming. Reprinted from A guide to reproducible code in ecology and evolution, by The British Ecological Society, 2017, Retrieved from: https://www.britishecologicalsociety.org/wp-content/uploads/2017/12/guide-to-reproducible-code.pdf. Copyright 2017 by British Ecological Society and authors Creative Commons Attribution 4.0 International License (http://creativecommons.org/licenses/by/4.0/)
2. A consistent script style can look like:

Open Science Initiative der WWU Münster (2018). Informations- und Lösungsmodule: Reproducible Codes. Adapted from https://osf.io/zc24b/

3. A consistent coding style should look like:


Open Science Initiative der WWU Münster (2018). Informations- und Lösungsmodule: Reproducible Codes. Adapted from https://osf.io/zc24b/

Zuletzt geändert: Mittwoch, 16. Oktober 2019, 13:12