Skip to content

Reorder dataset description page to show fields table first #375

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
gmarav05 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Reorder dataset description page to show fields table first #375

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
32 changes: 17 additions & 15 deletions docs/user_guide/dataset_description.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,23 @@ This file is adapted from the `dataset_description.json` from [BIDS](https://bid

Information from the dataset description will be displayed to a user when they discover your dataset in the Neurobagel query tool.

## Dataset description fields

Neurobagel recognizes the following fields in the dataset description JSON file. Extra keys are ignored. * indicates a key adopted from the BIDS [`dataset_description.json`](https://bids-specification.readthedocs.io/en/stable/modality-agnostic-files/dataset-description.html).

Key name | Requirement level | Data type | Description
---- | ---- | ---- | ----
Name* | REQUIRED | string | Name of the dataset. This name will be displayed when users discover the dataset in a Neurobagel query.
Authors* | RECOMMENDED | list of strings | List of individuals who contributed to the creation/curation of the dataset.
ReferencesAndLinks* | RECOMMENDED | list of strings | List of links or references that contain information on the dataset. **NOTE:** The first valid URL in this list will also be used as the dataset homepage when the dataset is discovered in the Neurobagel query tool.
Keywords* | RECOMMENDED | list of strings | List of keywords describing the content or subject matter of the dataset.
RepositoryURL | RECOMMENDED | string | URL to a repository where the dataset can be downloaded or retrieved from (e.g., DataLad, Zenodo, GitHub).
AccessInstructions | RECOMMENDED | string | Description of how to access the data.
AccessType | RECOMMENDED | string, one of: `"public"`, `"registered"`, `"restricted"` | Level of requirements for accessing the data. `public`: Immediately accessible without registration, authentication, or approval. `registered`: Requires authentication or agreement to basic terms of use, but no formal application or review. `restricted`: Requires formal approval or review of a data access request.
AccessEmail | RECOMMENDED | string (email) | Primary email for access requests.
AccessLink | RECOMMENDED | string | Primary link for access requests or information.


## Example
```json
--8<-- "https://raw.githubusercontent.com/neurobagel/neurobagel_examples/refs/heads/main/data-upload/synthetic_dataset_description.json"
Expand Down Expand Up @@ -57,18 +74,3 @@ We recommend using an informative file name like `DATASETNAME_description.json`.

**NOTE:** The editable template does not include all required keys for a valid BIDS `dataset_description.json`. Do not overwrite your existing BIDS `dataset_description.json` with the template, only add Neurobagel-supported keys as needed.

## Dataset description fields

Neurobagel recognizes the following fields in the dataset description JSON file. Extra keys are ignored. * indicates a key adopted from the BIDS [`dataset_description.json`](https://bids-specification.readthedocs.io/en/stable/modality-agnostic-files/dataset-description.html).

Key name | Requirement level | Data type | Description
---- | ---- | ---- | ----
Name* | REQUIRED | string | Name of the dataset. This name will be displayed when users discover the dataset in a Neurobagel query.
Authors* | RECOMMENDED | list of strings | List of individuals who contributed to the creation/curation of the dataset.
ReferencesAndLinks* | RECOMMENDED | list of strings | List of links or references that contain information on the dataset. **NOTE:** The first valid URL in this list will also be used as the dataset homepage when the dataset is discovered in the Neurobagel query tool.
Keywords* | RECOMMENDED | list of strings | List of keywords describing the content or subject matter of the dataset.
RepositoryURL | RECOMMENDED | string | URL to a repository where the dataset can be downloaded or retrieved from (e.g., DataLad, Zenodo, GitHub).
AccessInstructions | RECOMMENDED | string | Description of how to access the data.
AccessType | RECOMMENDED | string, one of: `"public"`, `"registered"`, `"restricted"` | Level of requirements for accessing the data. `public`: Immediately accessible without registration, authentication, or approval. `registered`: Requires authentication or agreement to basic terms of use, but no formal application or review. `restricted`: Requires formal approval or review of a data access request.
AccessEmail | RECOMMENDED | string (email) | Primary email for access requests.
AccessLink | RECOMMENDED | string | Primary link for access requests or information.