Add a dataset

We are very keen to incorporate other published datasets on worm neuronal connectivity into this package and add them to this website. You can either A) add it yourself to the code, or B) tell us about it and we can add it for you.

A) Add it yourself

1) Fork the main repository.

2) Add the source file of your dataset (usually the adjacency matrices of connection weights in, for example csv, Excel or Matlab format) into the data folder.

3) Create a Reader for the dataset, which converts it to our internal format. See examples for loading structured datasets in CSV format, XLSX format or XLS format.

4) Add the new data reader to the list of readers in Comparison.py (at 2 locations - see how Cook2020 is handled there).

5) Run ./test.sh in your local directory (or ./test.sh -q for a quicker test) to install the latest version of the code and attempt to regenerate the website locally with your changes.

6) Commit the code and open a pull request to https://github.com/openworm/ConnectomeToolbox with your changes. Note, enabling GitHub Actions on the repository containing your fork will cause a number of tests to be run automatically when you commit, which should pass before you open the pull request.

B) Tell us about the dataset

Please contact p.gleeson AT ucl.ac.uk with details of the missing resource (or just a link to the relevant publication) and we can discuss adding this to our codebase.