Skip to content

Commit

Permalink
Removed backticks from non-code non-filename text (#28)
Browse files Browse the repository at this point in the history
* removed backticks from non-code non-filename text

* Typo fix.

---------

Co-authored-by: Joe Ziminski <[email protected]>
  • Loading branch information
niksirbi and JoeZiminski authored Jun 26, 2023
1 parent ff1199d commit 4699e3c
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 12 deletions.
4 changes: 2 additions & 2 deletions docs/source/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@
<img src="_static/swc-blueprint_logo-light_no-text.png" alt="SWC-Blueprint logo" class="only-light img-responsive"/>
<img src="_static/swc-blueprint_logo-dark_no-text.png" alt="SWC-Blueprint logo" class="only-dark img-responsive"/>

`SWC-Blueprint` is a folder structure specification for (systems) neuroscience research projects. It is inspired by, and based on the [BIDS specification](https://bids-specification.readthedocs.io/en/stable/), widely used in human neuroimaging.
**SWC-Blueprint** is a folder structure specification for (systems) neuroscience research projects. It is inspired by, and based on the [BIDS specification](https://bids-specification.readthedocs.io/en/stable/), widely used in human neuroimaging.

The [SWC-Blueprint specification](specification.md) provides a set of rules and guidelines for project folder organisation, ensuring consistent data management within and between labs. The focus is on ensuring minimal overhead for researchers.

`SWC-Blueprint` is being developed at the [Sainsbury Wellcome Centre (SWC) for Neural Circuits and Behaviour](https://www.sainsburywellcome.org/) by members of the [Neuroinformatics Unit (NIU)](https://neuroinformatics.dev/). As such, it prioritizes interoperability with NIU-developed data analysis tools.
**SWC-Blueprint** is being developed at the [Sainsbury Wellcome Centre (SWC) for Neural Circuits and Behaviour](https://www.sainsburywellcome.org/) by members of the [Neuroinformatics Unit (NIU)](https://neuroinformatics.dev/). As such, it prioritizes interoperability with NIU-developed data analysis tools.

That said, the specification is designed to be as general as possible, and should be useful to anyone within the neuroscience field. We (the NIU) welcome [feedback](https://github.com/neuroinformatics-unit/SWC-Blueprint/discussions) and contributions from the wider community and commit to maintaining the specification as a living and evolving document. We will also collaborate with [ongoing efforts](https://github.com/INCF/neuroscience-data-structure) by the [INCF](https://www.incf.org/) and [BIDS community](https://bids.neuroimaging.io/) to extend the BIDS specification to non-human animal research.

Expand Down
20 changes: 10 additions & 10 deletions docs/source/specification.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# The specification

The current version of `SWC-Blueprint` mainly aims to enforce a uniform and consistent [project folder structure](#project-folder-structure).
The current version of **SWC-Blueprint** mainly aims to enforce a uniform and consistent [project folder structure](#project-folder-structure).
In addition, it also includes some non-mandatory conventions for [naming files](#file-naming-conventions) and storing [tabular metadata](#tabular-metadata).

:::{note}
Expand All @@ -26,13 +26,13 @@ For example:

* `derivatives`: any processed data that is derived from `rawdata` (e.g. spike sorting or pose estimation).

* Data within the `rawdata` folder *must* be hierarchically structured into `subject/session/datatype` levels. Each level *must* contain at least one folder corresponding to the next (lower) level.
* Data within the `rawdata` folder *must* be hierarchically structured into subject/session/datatype levels. Each level *must* contain at least one folder corresponding to the next (lower) level.

* `subject` and `session` folder names *must* consist of key-value pairs separated by underscores, withous spaces e.g. `sub-001_id-5645332`.
* 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`, `histology`.

* If collected, `ephys`, `behav`, `funcimg` *must* be placed under the `session` level. If collected, `histology` *must* be placed under the `subject` level.
* If collected, `ephys`, `behav`, `funcimg` *must* be placed under the session level. If collected, `histology` *must* be placed under the subject 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 @@ -78,7 +78,7 @@ The following datatypes are supported:
* `histology`: anatomical (e.g. serial-2-photon images)

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

### Example project folder
Expand Down Expand Up @@ -110,7 +110,7 @@ A real project folder might look like:

## File naming conventions

`SWC-Blueprint` imposes no absolute requirements on file names. That said, below we provide some recommendations for file names, based on the [BIDS specification](https://bids-specification.readthedocs.io/en/stable/02-common-principles.html#filenames).
**SWC-Blueprint** imposes no absolute requirements on file names. That said, below we provide some recommendations for file names, based on the [BIDS specification](https://bids-specification.readthedocs.io/en/stable/02-common-principles.html#filenames).

:::{admonition} What makes a good file name?
:class: tip
Expand All @@ -130,7 +130,7 @@ A real project folder might look like:
* Anything after the left-most stop (`.`) is considered as the file extension.
* `sub` and `ses` *should* be included in the filename. This can seem redundant, given that the file is already in a `sub-<label>/ses-<label>` folder, but it makes it easier to identify the file if it is moved out of its original folder.
* Additional information, such as the task name, or run number, *may* be included as further key-value pairs, e.g. `sub-001_ses-001_task-escape_run-001.csv`
* If the acquisition software outputs data with its own mandatory file naming convention, these *should* be placed under a folder that follows the `SWC-Blueprint` naming conventions, e.g.:
* If the acquisition software outputs data with its own mandatory file naming convention, these *should* be placed under a folder that follows the **SWC-Blueprint** naming conventions, e.g.:

```
└── my_project/
Expand All @@ -144,7 +144,7 @@ A real project folder might look like:
```

### Example file names
Below we provide some example file names adhering to the `SWC-Blueprint` naming conventions.
Below we provide some example file names adhering to the **SWC-Blueprint** naming conventions.

```
└── project/
Expand All @@ -165,7 +165,7 @@ Below we provide some example file names adhering to the `SWC-Blueprint` naming

## Metadata conventions

`SWC-Blueprint` imposes no absolute requirements on how to store metadata. That said, we do outline some best practices, in accordance with the [BIDS specification on tabular files](https://bids-specification.readthedocs.io/en/stable/02-common-principles.html#tabular-files).
**SWC-Blueprint** imposes no absolute requirements on how to store metadata. That said, we do outline some best practices, in accordance with the [BIDS specification on tabular files](https://bids-specification.readthedocs.io/en/stable/02-common-principles.html#tabular-files).

### Tabular metadata
Tabular metadata, e.g. a table describing the animals in the project, *should* be saved as a tab-separated value file (TSV, ending with `.tsv`) , that is, a CSV file where commas are replaced by tabs. The tab character is a less ambiguous delimiter compared to commas, as it is less likely to appear in data. This makes TSV less prone to parsing errors.
Expand Down

0 comments on commit 4699e3c

Please sign in to comment.