https://github.com/lindenb/hts-rdf
Managing sequencing data with RDF
https://github.com/lindenb/hts-rdf
bam bioinformatics data-management ontology rdf sparql tutorial vcf
Last synced: 5 months ago
JSON representation
Managing sequencing data with RDF
- Host: GitHub
- URL: https://github.com/lindenb/hts-rdf
- Owner: lindenb
- License: mit
- Created: 2023-09-08T07:55:38.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2023-09-15T17:29:07.000Z (almost 3 years ago)
- Last Synced: 2026-02-12T07:52:48.895Z (6 months ago)
- Topics: bam, bioinformatics, data-management, ontology, rdf, sparql, tutorial, vcf
- Language: Makefile
- Homepage:
- Size: 90.8 KB
- Stars: 11
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Citation: CITATION.cff
Awesome Lists containing this project
README
# hts-rdf
Author: Pierre Lindenbaum PhD.
Here are a few notes about Managing sequencing data with RDF. I want to keep track of the samples, BAMs, references, diseases etc.. used in my lab.
- This document is auto-generated using a [Makefile](Makefile). Do not edit it.
- I don't want to use a `SQL` database.
- I don't want to join too many tab delimited files.
- I want to use a controlled vocabulary to define things like diseases, organims, etc...
- This document is NOT a tutorial for `RDF` or `SPARQL`.
- I use the `RDF+XML` notation because I 'm used to work with `XML`.
- I created a namespace for my lab: `https://umr1087.univ-nantes.fr/rdf/` and a `XML` entity for this namespace: `&u1087;`.
- I tried to reuse existing ontologies (e.g. `foaf:Person` for samples) as much as I can, but sometimes I created my own classes and properties.
- I'm not an expert of `SPARQL` or `RDF`
- Required tools are (jena)[https://jena.apache.org/download/], `bcftools` (for `VCFs`), `samtools` (for `BAMs`), `awk`.
# Building the RDF GRAPH
## Species
I manually wrote [data/species.rdf](data/species.rdf) defining the species used in my lab.
We will use `rdf:subClassOf` to find organisms that are a sub-species of a taxon in the NCBI taxonomy tree.
```rdf
(...)
Homo Sapiens
Homo
Hominidae
Homo sapiens neanderthalensis
Rotavirus
ROOT
```

## Diseases / Phenotypes
I manually wrote [data/diseases.rdf](data/diseases.rdf) defining the diseases used in my lab.
We will use `rdf:subClassOf` to find diseases that are a sub-disease in a disease ontology tree.
```rdf
(...)
Coronavirus infectious disease
COVID-19
Severe COVID-19
Turner Syndrome
```

## References / FASTA / Genomes
I manually wrote [data/references.tsv](data/references.tsv) a tab delimited text file defining each `FASTA` reference genome available on my cluster.
The taxon id will be used to retrive the species associated to a `FASTA` file.
```
#path genomeId ucsc taxid
data/hg19.fasta grch37 hg19 9606
data/hg38.fasta grch38 hg38 9606
data/rotavirus_rf.fa rotavirus 10912
```
The table is transformed into `RDF` using `awk`:
```bash
tail -n+2 data/references.tsv |\
awk -F '\t' '{printf("\n\t%s\n\t%s\n",$2,$2,$1);if($4!="") printf("\t\n",$4); printf("\n");}'
```
output:
```rdf
(...)
grch37
data/hg19.fasta
grch38
data/hg38.fasta
rotavirus
data/rotavirus_rf.fa
```
## Samples
I manually wrote [data/samples.rdf](data/samples.rdf) defining the samples sequenced in my lab.
This is where we can define the gender, associate a sample to a diseases and where we can define the familial relations.
The Class `foaf:Group` is used to create a group of samples.
```rdf
(...)
S1
female
S2
female
S3
male
Fam01
```
## VCF BCF
### VCF and genomes
for each `VCF` files, we need to associate a `VCF` and the reference genome:
`Chromosome` and `length` are extracted from the references, we calculate the `md5` checksum and we sort on `md5`.
```bash
tail -n+2 data/references.tsv | sort -T TMP -t $'\t' -k1,1 > TMP/sorted.refs.txt
cut -f 1 TMP/sorted.refs.txt | while read FA; do echo -ne "${FA}\t" && cut -f 1,2 "${FA}.fai" | md5sum | cut -d ' ' -f 1; done > TMP/references.md5.tmp.a
join -t $'\t' -1 1 -2 1 TMP/sorted.refs.txt TMP/references.md5.tmp.a | sort -t $'\t' -k5,5 > TMP/references.md5
rm -f TMP/references.md5.tmp.a
```
For each `VCF`, the header is extracted, we extract the `chromosome` and `length` of the `contig` lines, we calculate the `md5` checksum and we sort on `md5`.
```bash
find data -type f \( -name "*.vcf.gz" -o -name "*.bcf" -o -name "*.vcf" \) | sort > TMP/vcfs.txt
(cat TMP/vcfs.txt| while read V ; \
do echo -en "${V}\t" && \
bcftools view --header-only "${V}" | awk -F '[=,<>]' '/^##contig/ {printf("%s\t%s\n",$4,$6);}' | md5sum | cut -d ' ' -f1 ; done) | sort -t $'\t' -k2,2 > TMP/vcfs.md5.txt
```
we join both files on `md5` and we convert to `RDF` using `awk`:
```bash
cat data/header.rdf.part > TMP/vcf2ref.rdf
join -t $'\t' -1 2 -2 5 TMP/vcfs.md5.txt TMP/references.md5 |\
awk -F '\t' '{printf("%s",$2,$2,$4); }' >> TMP/vcf2ref.rdf
cat data/footer.rdf.part >> TMP/vcf2ref.rdf
```
### VCF and samples
to link the `VCF` files and the sample, we use `bcftools query -l` to extract the samples and we convert to `RDF` using `awk`:
```bash
find data -type f \( -name "*.vcf.gz" -o -name "*.bcf" -o -name "*.vcf" \) | sort > TMP/vcfs.txt
cat data/header.rdf.part > TMP/vcf2samples.rdf
cat TMP/vcfs.txt | while read F; do bcftools query -l "${F}" | awk -vVCF="$F" 'BEGIN {printf("%s",VCF,VCF); } {printf("",$1);} END {printf("");}' >> TMP/vcf2samples.rdf ; done
cat data/footer.rdf.part >> TMP/vcf2samples.rdf
```
## BAM files
`BAM` file contains the sample names in their read-groups; We use `samtools samples` to extract the samples, the reference and the path of each `BAM` file.
[data/samtools.samples.to.rdf.awk](data/samtools.samples.to.rdf.awk) is used to convert the output of `samtools samples` to `RDF`.
```bash
find ${PWD}/data -type f -name "*.bam" |\
samtools samples -F TMP/references.txt |\
sort -T TMP -t $'\t' -k3,3 |\
join -t $'\t' -1 3 -2 1 - TMP/sorted.refs.txt > TMP/bams.txt
cat data/header.rdf.part > TMP/bams.rdf
awk -F '\t' -f data/samtools.samples.to.rdf.awk TMP/bams.txt >> TMP/bams.rdf
cat data/footer.rdf.part >> TMP/bams.rdf
```
the output:
```rdf
(...)
S5
/home/lindenb/src/hts-rdf/data/S5.grch38.bam
(...)
```
## Combining all the RDF chunks
[jena/rio](https://jena.apache.org/) is used to merge `RDF` files into [knowledge.rdf](knowledge.rdf)
```bash
riot --formatted=RDFXML TMP/references.rdf data/species.rdf TMP/bams.rdf data/diseases.rdf data/samples.rdf TMP/vcf2ref.rdf TMP/vcf2samples.rdf > knowledge.rdf
```
# Querying the GRAPH
[jena/arq](https://jena.apache.org/) is used to run the `SPARQL` queries.
```bash
arq --data=knowledge.rdf --query=querysparql
```
## Example
> show me the species that are a sub-taxon of "Homo"
query [data/query.species.01.sparql](data/query.species.01.sparql) :
```sparql
(...)
SELECT DISTINCT ?taxonName
WHERE {
?taxon dc:title ?taxonName .
?taxon a u:Taxon .
?taxon rdfs:subClassOf* ?root .
?root a u:Taxon .
?root dc:title "Homo" .
}
```
execute:
```bash
arq --data=knowledge.rdf --query=data/query.species.01.sparql > TMP/species.01.out
```
output [TMP/species.01.out](TMP/species.01.out):
| taxonName |
|-----|
| "Homo sapiens neanderthalensis" |
| "Homo Sapiens" |
| "Homo" |
## Example
> show the diseases that are a sub disease of **COVID-19**.
query [data/query.diseases.01.sparql](data/query.diseases.01.sparql) :
```sparql
(...)
SELECT DISTINCT ?diseaseName
WHERE {
?disease rdfs:label ?diseaseName .
?disease a owl:Class .
?disease rdfs:subClassOf* ?root .
?root a owl:Class .
?root rdfs:label "COVID-19" .
}
```
execute:
```bash
arq --data=knowledge.rdf --query=data/query.diseases.01.sparql > TMP/diseases.01.out
```
output [TMP/diseases.01.out](TMP/diseases.01.out):
| diseaseName |
|-----|
| "COVID-19" |
| "Severe COVID-19" |
## Example
> find the samples , their children, parents , diseases
query [data/query.samples.01.sparql](data/query.samples.01.sparql) :
```sparql
(...)
SELECT DISTINCT
(SAMPLE(?sampleName) as ?colName)
(SAMPLE(?gender) as ?colGender )
(SAMPLE(?fatherName) as ?colFather )
(SAMPLE(?motherName) as ?colMother)
(GROUP_CONCAT(DISTINCT ?childName; SEPARATOR=";") as ?colChildren)
(GROUP_CONCAT(DISTINCT ?diseaseName; SEPARATOR=";") as ?colDiseases)
WHERE {
?sample a foaf:Person .
?sample foaf:name ?sampleName .
OPTIONAL {?sample foaf:gender ?gender .}
OPTIONAL {
?sample u:has-disease ?disease .
?disease a owl:Class .
?disease rdfs:label ?diseaseName .
} .
OPTIONAL {
?father a foaf:Person .
?sample rel:childOf ?father .
?father foaf:gender "male" .
?father foaf:name ?fatherName .
} .
OPTIONAL {
?mother a foaf:Person .
?sample rel:childOf ?mother .
?mother foaf:gender "female" .
?mother foaf:name ?motherName .
} .
OPTIONAL {
?child a foaf:Person .
?child rel:childOf ?sample .
?child foaf:name ?childName .
} .
}
GROUP BY ?sample
```
execute:
```bash
arq --data=knowledge.rdf --query=data/query.samples.01.sparql > TMP/samples.01.out
```
output [TMP/samples.01.out](TMP/samples.01.out):
| colName | colGender | colFather | colMother | colChildren | colDiseases |
|-----|-----|-----|-----|-----|-----|
| "S1" | "female" | "S3" | "S2" | | "Turner Syndrome;COVID-19" |
| "S2" | "female" | | | "S1" | |
| "S3" | "male" | | | "S1" | "Severe COVID-19" |
| "S4" | | | | | |
| "S5" | | | | | |
## Example
> List all the `VCF` files and their samples, at least containing the sample "S1"
query [data/query.vcfs.01.sparql](data/query.vcfs.01.sparql) :
```sparql
(...)
SELECT DISTINCT ?vcfPath ?fasta ?taxonName ?sampleName
WHERE {
?vcf a u:Vcf .
?vcf u:filename ?vcfPath .
?vcf u:sample ?sample1 .
?sample1 a foaf:Person .
?sample1 foaf:name "S1" .
?vcf u:sample ?sample2 .
?sample2 a foaf:Person .
?sample2 foaf:name ?sampleName .
OPTIONAL {
?vcf u:reference ?ref .
?ref a u:Reference .
?ref u:filename ?fasta
OPTIONAL {
?ref u:taxon ?taxon .
?taxon a u:Taxon .
?taxon dc:title ?taxonName .
}
}
}
```
execute:
```bash
arq --data=knowledge.rdf --query=data/query.vcfs.01.sparql > TMP/vcfs.01.out
```
output [TMP/vcfs.01.out](TMP/vcfs.01.out):
| vcfPath | fasta | taxonName | sampleName |
|-----|-----|-----|-----|
| "data/variants2.vcf" | "data/hg19.fasta" | "Homo Sapiens" | "S1" |
| "data/variants2.vcf" | "data/hg19.fasta" | "Homo Sapiens" | "S2" |
| "data/variants2.vcf" | "data/hg19.fasta" | "Homo Sapiens" | "S3" |
| "data/variants1.vcf" | "data/hg38.fasta" | "Homo Sapiens" | "S1" |
| "data/variants1.vcf" | "data/hg38.fasta" | "Homo Sapiens" | "S5" |
| "data/variants1.vcf" | "data/hg38.fasta" | "Homo Sapiens" | "S2" |
| "data/variants1.vcf" | "data/hg38.fasta" | "Homo Sapiens" | "S3" |
## Example
> find the bam , their reference, samples , etc..
query [data/query.bams.01.sparql](data/query.bams.01.sparql) :
```sparql
(...)
SELECT DISTINCT ?bamPath
(SAMPLE(?fasta) as ?colFasta)
(SAMPLE(?taxonName) as ?colTaxon)
(SAMPLE(?sampleName) as ?colSampleName )
(GROUP_CONCAT(DISTINCT ?groupName; SEPARATOR=";") as ?colGroups )
(GROUP_CONCAT(DISTINCT ?gender; SEPARATOR=";") as ?colGender )
(GROUP_CONCAT(DISTINCT ?diseaseName; SEPARATOR=";") as ?colDiseases)
(SAMPLE(?fatherName) as ?colFather )
(SAMPLE(?motherName) as ?colMother)
(GROUP_CONCAT(DISTINCT ?childName; SEPARATOR="; ") as ?colChildren)
WHERE {
?bam a u:Bam .
?bam u:filename ?bamPath .
OPTIONAL {
?bam u:reference ?ref .
?ref a u:Reference .
?ref u:filename ?fasta
OPTIONAL {
?ref u:taxon ?taxon .
?taxon a u:Taxon .
?taxon dc:title ?taxonName .
}
}
OPTIONAL {
?bam u:sample ?sample .
?sample a foaf:Person .
OPTIONAL {?sample foaf:name ?sampleName .}
OPTIONAL {?sample foaf:gender ?gender .}
OPTIONAL {
?group foaf:member ?sample .
?group a foaf:Group .
?group foaf:name ?groupName .
} .
OPTIONAL {
?sample u:has-disease ?disease .
?disease a owl:Class .
?disease rdfs:label ?diseaseName .
} .
OPTIONAL {
?father a foaf:Person .
?sample rel:childOf ?father .
?father foaf:gender "male" .
?father foaf:name ?fatherName .
} .
OPTIONAL {
?mother a foaf:Person .
?sample rel:childOf ?mother .
?mother foaf:gender "female" .
?mother foaf:name ?motherName .
} .
OPTIONAL {
?child a foaf:Person .
?child rel:childOf ?sample .
?child foaf:name ?childName .
} .
}.
}
GROUP BY ?bamPath
```
execute:
```bash
arq --data=knowledge.rdf --query=data/query.bams.01.sparql > TMP/bams.01.out
```
output [TMP/bams.01.out](TMP/bams.01.out):
| bamPath | colFasta | colTaxon | colSampleName | colGroups | colGender | colDiseases | colFather | colMother | colChildren |
|-----|-----|-----|-----|-----|-----|-----|-----|-----|-----|
| "/home/lindenb/src/hts-rdf/data/S1.grch38.bam" | "data/hg38.fasta" | "Homo Sapiens" | "S1" | "Fam01" | "female" | "Turner Syndrome;COVID-19" | "S3" | "S2" | |
| "/home/lindenb/src/hts-rdf/data/S2.grch37.bam" | "data/hg19.fasta" | "Homo Sapiens" | "S2" | "Fam01" | "female" | | | | "S1" |
| "/home/lindenb/src/hts-rdf/data/S4.RF.bam" | "data/rotavirus_rf.fa" | "Rotavirus" | "S4" | | | | | | |
| "/home/lindenb/src/hts-rdf/data/S5.grch38.bam" | "data/hg38.fasta" | "Homo Sapiens" | "S5" | "Fam01" | | | | | |
| "/home/lindenb/src/hts-rdf/data/S3.grch38.bam" | "data/hg38.fasta" | "Homo Sapiens" | "S3" | "Fam01" | "male" | "Severe COVID-19" | | | "S1" |
| "/home/lindenb/src/hts-rdf/data/S1.grch37.bam" | "data/hg19.fasta" | "Homo Sapiens" | "S1" | "Fam01" | "female" | "Turner Syndrome;COVID-19" | "S3" | "S2" | |
# The Graph
and here is the `RDF` graph as a `SVG` document:
