expfactory / experiments

library of version controlled, tested experiments for expfactory

Home Page:https://expfactory.github.io/experiments/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Requirements for config.json

vsoch opened this issue · comments

These are relatively simple to provide, so it should be reasonable.

Required

  • exp_id: must not yet exist for all expfactory experiments, alphanumerical / _ and - allowed.
  • url: the repository where the code is maintained
  • description: tell us what it is
  • time: estimated time to complete experiment, in minutes

Optional

  • contributors: a list of contributor names
  • cognitive_atlas_task_id: if relevant
  • notes: any additional notes
  • template: a html/framework template, if relevant
  • reference: references, if this is important to you

These will be checked in the CI, and added to the CONTRIBUTING.md document.

This is also done.