Humboldt-Universität zu Berlin - Forschungsdatenmanagement

Readme example

Beispiel für eine Datendokumentation in Form einer Readme-Datei.

text/plain Readme-Example.txt — 1.8 KB


Documentation of research project XYZ

Creator: Maxi Mustermann, Humboldt-Universitt zu Berlin, Unter den Linden 6, 10099 Berlin, ORCID: 0000-0002-2775-6751

Research context and hypotheses (reason(s) for data analysis): 
The data was collected within project XYZ which investigates, why students at German Higher Education institutions don't document their data.
H1: If students learn about data management during their studies, they hand in a data documentation file with their thesis.

Creation date of files: 12-2019

Data collection/creation method: Survey among 500 Master students at German Higher Education institutions. Students were sampled randomly.

Used Software (incl. version and add-ons), tools or devices:
- R x64 version 3.2.3

- Project-XYZ-survey.csv
  - Anonymized dataset of the survey
  - Outliers were deleted
  - Free text answers are in German, variable description and codes are in English

- Project-XYZ-survey.r
  - R code for data analysis and creation of fig. 1-3
  - R code is documented in English

Additional documentation files:
- Project-XYZ-survey-questionnaire.pdf
  - The questionnaire includes all questions in German and an English translation
- Project-XYZ-survey-variable-description.pdf
  - The variable description explains the variables and their values
  - The description is in English

Information on access and terms of use (license):
Anonymized data is available without access restrictions. Unanonymized data is available from the creator for secondary analysis. All data, files and code are licenced under a Creative Commons Attribution 4.0 International (CC BY 4.0) licence (

The follow-up project XXX focusses on the effects of data availability on the citation of research data.