Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Note: Both relative and absolute paths can be used to specify files or directori

## Build

To spin up the side locally while you edit it, run:
To spin up the site locally while you edit it, run:

`mkdocs serve`

Expand Down Expand Up @@ -77,7 +77,7 @@ pre-commit install

After this the style guide will be enforced every time you commit:
some pre-commit 'hooks' will try to fix some of the errors they find,
so you may have to restaage your file before committing.
so you may have to restage your file before committing.

For markdownlint, you can also use
the [VS-code extension](https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint)
Expand Down
2 changes: 1 addition & 1 deletion docs/contributing/team.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Neurobagel is a project originating from the [ORIGAMI Lab](https://neurodatascie
</tr>
<tr>
<td align="center"><a href="https://github.com/Remi-Gau"><img src="../../overrides/assets/img/remi_gau.jpeg" width="100px;" alt=""/><br /><sub><b>Remi Gau</b></sub></td>
<td align="center"><a href="https://www.mcgill.ca/neuro/jean-baptiste-poline-phd"><img src="../../overrides/assets/img/jb.jpg" width="100px;" alt=""/><br /><sub><b>Jean-Baptise Poline</b></sub></a><br/>🧑‍🔬</td>
<td align="center"><a href="https://www.mcgill.ca/neuro/jean-baptiste-poline-phd"><img src="../../overrides/assets/img/jb.jpg" width="100px;" alt=""/><br /><sub><b>Jean-Baptiste Poline</b></sub></a><br/>🧑‍🔬</td>
</tr>
</table>

Expand Down
4 changes: 2 additions & 2 deletions docs/data_models/dictionaries.md
Original file line number Diff line number Diff line change
Expand Up @@ -359,15 +359,15 @@ contain any `MissingValues`.

For the above example, this would be:

| particpant_id | updrs_1 | updrs_2 |
| participant_id | updrs_1 | updrs_2 |
| ------------- | ------- | ------- |
| sub-01 | 2 | |
| sub-02 | 1 | 1 |
| sub-03 | | |

Therefore:

| particpant_id | updrs_available |
| participant_id | updrs_available |
| ------------- | --------------- |
| sub-01 | True |
| sub-02 | True |
Expand Down
2 changes: 1 addition & 1 deletion docs/data_models/graph_data.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Overview
Using the Neurobagel CLI (see also the [section on the CLI](../user_guide/cli.md)),
a Neurobagel data dictionary (`.json`) for a dataset can be processed together with the corresponding tabular data (`.tsv`) and BIDS dataset (if available) to generate subject-level [linked data](https://www.w3.org/wiki/LinkedData) that can be encoded in a knowledge graph.
a Neurobagel data dictionary (`.json`) for a dataset can be processed together with the corresponding tabular data (`.tsv`) and BIDS dataset (if available) to generate subject-level [linked data](https://en.wikipedia.org/wiki/Linked_data) that can be encoded in a knowledge graph.
The Neurobagel graph-ready data are stored in [JSON-LD](https://json-ld.org/) format (`.jsonld`),
and include a representation of each subject's harmonized phenotypic properties and imaging metadata.

Expand Down
2 changes: 1 addition & 1 deletion docs/data_models/term_naming_standards.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
- Names should adhere to camelCase (uses capitalized words except for the first word/letter)
- Should be a compound of:
- a verb relevant to the property (e.g., **has**Age, **is**SubjectGroup)
- the [range](https://www.w3.org/TR/owl-ref/#range-def) of the property, (e.g.,has**Diagnosis** points to a Diagnosis object)
- the [range](https://www.w3.org/TR/owl-ref/#range-def) of the property, (e.g., has**Diagnosis** points to a Diagnosis object)

What this might look like in semantic triples:

Expand Down
2 changes: 1 addition & 1 deletion docs/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ This glossary compiles some key terms used in the Neurobagel documentation and d
### Graph database
**Used interchangeably with**: knowledge graph store, graph store, graph

: A type of database, in the same way that a relational databases is a type of database.
: A type of database, in the same way that a relational database is a type of database.
The main distinguishing feature of graph databases is that they
represent entities as nodes in a graph,
and relationships between entities as edges between these nodes.
Expand Down
2 changes: 1 addition & 1 deletion docs/user_guide/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
Neurobagel has two flavours of APIs that can be deployed: **node API** and **federation API**.

- A [Neurobagel node API (n-API)](https://github.com/neurobagel/api) formulates SPARQL queries based on a set of user-defined parameters to a single connected graph database, and processes returned query results into a user-friendly format.
- A [Neurobagel federation API (f-API)](https://github.com/neurobagel/federation-api) lets the user sends a single query to _each_ node API it is aware of, and collects and combines the decentralized responses into a single set of query results.
- A [Neurobagel federation API (f-API)](https://github.com/neurobagel/federation-api) lets the user send a single query to _each_ node API it is aware of, and collects and combines the decentralized responses into a single set of query results.

Neurobagel's query tool provides a GUI for querying one or more Neurobagel graphs by sending requests to a Neurobagel _federation API_ instance.
However, HTTP requests can also be sent directly to any publicly accessible Neurobagel API (node or federation).
Expand Down
2 changes: 1 addition & 1 deletion docs/user_guide/data_prep.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
To use the Neurobagel annotation tool,
you must prepare the tabular data for your dataset as a single tab-separated values (`.tsv`) file.

Within Neurobagel, tabular (or phenotypic) data refers to any demographic, clinical/behavioural, cognitive, or other non-imaging-derived data of participants
Within Neurobagel, tabular (or phenotypic) data refers to any demographic, clinical/behavioural, cognitive, or other non-imaging-derived data of participants
which are typically stored in a tabular format.

## Requirements for the phenotypic TSV
Expand Down
2 changes: 1 addition & 1 deletion docs/user_guide/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ Docker Compose recipe and template configuration files for setting up a local Ne

!!! info "Production deployments require additional configuration"

This section provide a minimal configuration for launching Neurobagel
This section provides a minimal configuration for launching Neurobagel
so you can get started quickly with trying out all services locally.
In most cases, particularly when deploying Neurobagel for other users,
additional configurations are necessary.
Expand Down
1 change: 1 addition & 0 deletions docs/user_guide/preparing_imaging_data.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ If your dataset is already in [BIDS](https://bids-specification.readthedocs.io/e
The BIDS metadata table lists each subject's available imaging files and modality information, using [BIDS](https://bids-specification.readthedocs.io/en/stable/) naming conventions, in the format shown below.

## Example BIDS metadata table

| sub | ses | suffix | path |
| ---- | ---- | ---- | ---- |
| sub-01 | ses-01 | T1w | /data/bids-examples/synthetic/sub-01/ses-01/anat/sub-01_ses-01_T1w.nii |
Expand Down