Experiments README - katielavigne/documentation GitHub Wiki
Standardized README File for Psychological Experiments (replace details in square brackets []). See example here and source code here.
[TITLE]
tags: [tags or keywords]
[Description]
Publication: [citation of publication or pre-print](DOI URL)
Function(s) assessed: [function(s) assessed]
Features
- Repeatability
- Multilingual
- Validated
- Accessibility
- Cross-platform
- Cross-device
- Cross-species
Alternate Forms: [number of alternate forms / not applicable / not available]
Languages: [list of languages available]
Validation: [brief description of validation measure(s) and population(s)]
Accessibility: [list of accessibility considerations, e.g., colourblind friendly]
Platforms: [list of platforms, e.g., online, offline, fMRI, EEG, MEG]
Devices: [list of devices, e.g., PC, smartphone, tablet]
Species: [list of species, e.g., human, marmoset, mouse, rat]
Development
Software: [software and version]
Requirements: [additional software/versions, licensing, etc]
Administration
[details on administering the experiment, including technical information and verbal instructions/prompts, as applicable]
Procedure and Conditions
[description of the task procedure and any conditions]
Output Files
[list of files output after completion of experiment and what they mean]
Scoring
[instructions for scoring, including variable names and descriptions and where to find the calculations]
Additional Features
[bulleted list of additional features you would like to highlight]
Planned Features
[bulleted list of upcoming or planned features]
How to Contribute
[description on how others can contribute to the development of this task (e.g., additional features, language translation, etc]
Contributors
[list of contributors and their contributions to the design and development of the experiment, including a contact person & information if desired]
License & Attribution
[specify license and main points (attributional, non-commercial) as well as citation requests]
Additional Reading
[list of research articles or documentation with URLs]