Skip to content
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.

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

[ENH] BEP018: Genetic information #287

Closed
wants to merge 31 commits into from
Closed
Changes from 28 commits
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
557bd47
Merge pull request #24 from bids-standard/master
franklin-feingold Jul 25, 2019
c7ef08c
Merge pull request #1 from bids-standard/master
Jul 31, 2019
858d540
Create 08-genetic-descriptor.md
CPernet Jul 31, 2019
39d71e2
Merge branch 'master' of https://github.com/CPernet/bids-specification
CPernet Jul 31, 2019
8431f14
formating
CPernet Jul 31, 2019
9434946
more formating
CPernet Jul 31, 2019
3ebc411
Merge pull request #25 from CPernet/master
franklin-feingold Aug 1, 2019
8a00e3c
Fix BEP018: Genetic Information
franklin-feingold Aug 1, 2019
f167318
fixed trialing issues and table closing
CPernet Aug 1, 2019
3280969
Update src/04-modality-specific-files/08-genetic-descriptor.md
Aug 8, 2019
0628909
Update src/04-modality-specific-files/08-genetic-descriptor.md
Aug 8, 2019
b5cb345
PR changes accepted
CPernet Aug 8, 2019
a61d704
remark 08-genetic-descriptor.md
franklin-feingold Aug 8, 2019
dedd94c
Merge branch 'master' into enh/genetics
Aug 9, 2019
f04c352
Merge pull request #2 from franklin-feingold/enh/genetics
Aug 9, 2019
272d7be
Update src/04-modality-specific-files/08-genetic-descriptor.md
Aug 10, 2019
00e506f
Update src/04-modality-specific-files/08-genetic-descriptor.md
Aug 10, 2019
ac805db
more empty line removal
CPernet Aug 10, 2019
13e574b
Update src/04-modality-specific-files/08-genetic-descriptor.md
Aug 13, 2019
a9bc60b
Update src/04-modality-specific-files/08-genetic-descriptor.md
Aug 13, 2019
225947c
Update src/04-modality-specific-files/08-genetic-descriptor.md
Aug 13, 2019
4adb6f1
Update src/04-modality-specific-files/08-genetic-descriptor.md
Aug 13, 2019
eea885d
Update src/04-modality-specific-files/08-genetic-descriptor.md
Aug 13, 2019
393e0e3
Update src/04-modality-specific-files/08-genetic-descriptor.md
Oct 24, 2019
b7da947
Update src/04-modality-specific-files/08-genetic-descriptor.md
Oct 24, 2019
c214e45
updated genetics as object
Oct 24, 2019
a8e6f55
mixed up in the table fixed
Oct 24, 2019
f2a93f8
Remove extra line and trailing space to try and fix linter
rwblair Oct 24, 2019
05ad824
have last row in table be same length as rest of rows in for genetic …
rwblair Oct 24, 2019
a82e127
Merge pull request #4 from rwblair/287
Oct 25, 2019
0fe56bb
Change "GeneticDataBase" to "Genetics" to match key name in rest of f…
rwblair Jan 15, 2020
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
81 changes: 81 additions & 0 deletions src/04-modality-specific-files/08-genetic-descriptor.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
# Genetic Descriptor

Support for genetic descriptors was developed as a [BIDS Extension Proposal](https://github.com/bids-standard/bids-specification/blob/master/src/06-extensions.md#bids-extension-proposals).
The extension was primarily developped by Cyril Pernet and Clara Moreau with contributions from Tom Nichols and Jessica Turner.
CPernet marked this conversation as resolved.
Show resolved Hide resolved

The goal of the genetic descriptor is to link imaging and genetic data.
This is necessary as genetic data are typically stored in dedicated repositories, separately from the imaging data.
The descriptor provides basics information about:
- where to find genetic information associated with the imaging data
CPernet marked this conversation as resolved.
Show resolved Hide resolved
- what type of genetic information is available

CPernet marked this conversation as resolved.
Show resolved Hide resolved
## dataset_description.json

In order to link a genetic database entry, the key `GeneticDataBase` MUST be present and
the value is an object with the following fields:
CPernet marked this conversation as resolved.
Show resolved Hide resolved

| Field name | Definition |
|----------------------|--------------------------------------------------------------------------------|
| Genetics.Dataset | REQUIRED. URI where data can be retrieved. |
| Genetics.Database | OPTIONAL. URI of database where the dataset is hosted. |
| Genetics.Descriptors | OPTIONAL. List of relevant descriptors (*e.g.*, journal articles) for dataset. |

CPernet marked this conversation as resolved.
Show resolved Hide resolved
`dataset_description.json` example:
```JSON
{
"Name": "Human Connectom Project",
"BIDSVersion": "1.2.0",
"License": "CC0",
"Authors": ["1st author", "2nd author"],
"Funding": "list your funding sources",
"Genetics": {
"Dataset": "dataset",
"Database": "database",
"Descriptors": "descriptors"
}
}
sappelhoff marked this conversation as resolved.
Show resolved Hide resolved
```

## Subject naming and Participants file

If the same participants have different identifiers in the genetic and imaging datasets,
the column `GeneticID` SHOULD be added to the `participants.tsv` file to associate
the BIDS participant with a subject in the `Genetics.Dataset` referred to in the
`dataset_description.json` file.

Information about the presence/absence of specific genetic markers MAY be duplicated
in the `participants.tsv` file by adding optional columns.

`participants.tsv` example:

```Text
participant_id age sex group GeneticID IDH Mutation
sub-control01 34 M control 124587 yes
sub-control02 12 F control 548936 yes
sub-patient01 33 F patient 489634 no
```

## genetic_info.json
CPernet marked this conversation as resolved.
Show resolved Hide resolved

This file is the descriptor of the genetic information available either in the participant tsv file and/or the genetic database described in the dataset_description.json. The `GeneticLevel` and `SampleOrigin` are the only two mandatory fields.

| Field name | Definition | Values |
| :----------------- | :------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| GeneticLevel | MANDATORY Describes the level of analysis | `Genetic`, `Genomic`, `Epigenomic`, `Transcriptomic`, `Metabolomic`, or `Proteomic` |
| AnalyticalApproach | OPTIONAL Methodology used to analyse the GeneticLevel | Value must be taken from [gapsolr](https://www.ncbi.nlm.nih.gov/projects/gapsolr/facets.html) under /Study/Molecular Data Type, for instance `SNP Genotypes (Array)` or `Methylation (CpG)` |
| SampleOrigin | MANDATORY Describes from which tissue the genetic information was extracted from | `blood`, `saliva`, `brain`, `csf`, `breast milk`, `bile`, `amniotic fluid`, `other biospecimen` |
| TissueOrigin | OPTIONAL Describes the type of tissue analyzed for SampleOrigin `brain` | `gray matter`, `white matter`, `csf`, `meninges`, `macrovascular` or `microvascular` |
| BrainLocation | OPTIONAL Refers to the location in space of the TissueOrigin | `MNI coordinate` or a `label` taken from the [Allen Brain Atlas](http://atlas.brain-map.org/atlas?atlas=265297125#atlas=265297125&plate=112360888&structure=4392&x=40348.15104166667&y=46928.75&zoom=-7&resolution=206.60&z=3) possibly `layer` to refer to layer-specific gene expression, which can also tie up with laminar fMRI |
| CellType | OPTIONAL Describes the type of cell analyzed | Value should come from the [cell ontology](http://obofoundry.org/ontology/cl.html) |

`genetic_info.json` example:

```JSON
{
"GeneticLevel": "Genetic",
"AnalyticalApproach": "SNP Genotypes", "SampleOrigin": "brain",
"TissueOrigin": "gray matter",
"CellType": "neuron",
"BrainLocation": "[-30 -15 10]"
}
sappelhoff marked this conversation as resolved.
Show resolved Hide resolved
```