Skip to content

Commit

Permalink
Change histology to anat and mandate at session level. (#46)
Browse files Browse the repository at this point in the history
  • Loading branch information
JoeZiminski authored Oct 20, 2023
1 parent 27e36f1 commit ba7b6f4
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 10 deletions.
Binary file modified docs/source/_static/NeuroBlueprint_logo-dark_no-text.png
100644 → 100755
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/source/_static/NeuroBlueprint_logo-light_no-text.png
100644 → 100755
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/source/_static/NeuroBlueprint_project_tree_dark.png
100644 → 100755
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/source/_static/NeuroBlueprint_project_tree_light.png
100644 → 100755
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
19 changes: 9 additions & 10 deletions docs/source/specification.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,9 @@ For example:

* Subject and session folder names *must* consist of key-value pairs separated by underscores, without spaces e.g. `sub-001_id-5645332`.

* Datatype folder names *must* be one of the following : `ephys`, `behav`, `funcimg`, `histology`.
* Datatype folder names *must* be one of the following : `ephys`, `behav`, `funcimg`, `anat`.

* If collected, `ephys`, `behav`, `funcimg` *must* be placed under the session level. If collected, `histology` *must* be placed under the subject level.
* Datatype folders *must* be placed under the session level.

Below we describe each level of the `rawdata` folder hierarchy in more detail. Though we impose no absolute requirements for the folder structure within `derivatives`, it *should* match the hierarchy in `rawdata` whenever possible.

Expand Down Expand Up @@ -77,11 +77,8 @@ The following datatypes are supported:
* `ephys`: electrophysiology (e.g. Neuropixel probes, tetrodes)
* `behav`: behavioural (e.g. video and audio files, response logs)
* `funcimg`: functional imaging (e.g. calcium and voltage imaging)
* `histology`: anatomical (e.g. serial-2-photon images)
* `anat`: anatomical (e.g. histology, using confocal or lightsheet)

:::{note}
Unlike the first three datatypes that belong at the session level, `histology` belongs at the subject level.
:::

### Example project folder
A real project folder might look like:
Expand All @@ -97,17 +94,19 @@ A real project folder might look like:
│ │ └── behav/
│ │ ├── sub-001_ses-01_camera-01.wav
│ │ └── sub-001_ses-01_data-responses.csv
│ └── histology/
│ └── sub-001_image-brain.tiff
│ └── ses-02_date-20230311/
│ └── anat/
│ └── sub-001_image-brain.tiff
└── derivatives/
└── sub-001_id-5645332/
├── ses-01_date-20230310/
│ ├── ephys/
│ │ └── sub-001_ses-01_data-spikes.npy
│ └── behav/
│ └── sub-001_ses-01_data-poses.csv
└── histology/
└── sub-001_ses-01_data-cellcounts.csv
└── ses-02_date-20230311/
└── anat/
└── sub-001_data-cellcounts.csv
```

## File naming conventions
Expand Down

0 comments on commit ba7b6f4

Please sign in to comment.