In isglobal-brge/CTDquerier: Package for CTDbase data query, visualization and downstream analysis

knitr::opts_chunk$set(fig.retina = 1)

Introduction

The Comparative Toxicogenomics Database

The Comparative Toxicogenomics Database (CTDbase; http://ctdbase.org) is a public resource for toxicogenomic information manually curated from the peer-reviewed scientific literature, providing key information about the interactions of environmental chemicals with gene products and their effect on human disease [@CTDbase2003][@CTDbase2017]. CTDbase is offered to public by using a web-based interface that includes basic and advanced query options to access data for sequences, references, and toxic agents, and a platform for analysing sequences.

CTDquerier R package

CTDquerier is an R package that allows to R users to download basic data from CTDbase about genes, chemicals and diseases. Once the user's input is validated allows to query CTDbase to download the information of the given input from the other modules.

CTDquerier can be installed using devtools. To install CTDquerier run the following command in an R session:

if ( !requireNamespace( "BiocManager", quietly = TRUE ) )
    install.packages("BiocManager")

BiocManager::install("CTDquerier")

Once installed, CTDquerier should be loaded running the following command:

library( CTDquerier )

The main function of CTDquerier are three depending of the input: genes, chemicals or diseases. Table \@ref(tab:CTDquerier-functions) indicates the proper function to be used to query CTDbase depending on the input.

| Input | Function | |:----------|:-----------------| | Genes | query_ctd_gene | | Chemicals | query_ctd_chem | | Diseases | query_ctd_dise |

: (#tab:CTDquerier-functions) Main functions of CTDquerier, designed to accept a specific input.

The function to query CTDbase relies on a set of function that download the specific vocabulary of each input. Table \@ref(tab:CTDquerier-vocabulary) shows the different functions that are used to download the specific vocabulary and to load it into R. This process is transparent to user since it is encapsulated into each one of the query functions.

| Input | Load Function | Download Function | |:----------|:----------------|:---------------------| | Genes | load_ctd_gene | download_ctd_genes | | Chemicals | load_ctd_chem | download_ctd_chem | | Diseases | load_ctd_dise | download_ctd_dise |

: (#tab:CTDquerier-vocabulary) Functions used to download and load specific vocabulary from CTDbase.

The three main functions of CTDquerier returns CTDdata objects. These objects can be used to plot the information available in CTDbase by using plot. Moreover, the informatin from CTDbase can be extracted as data.frames using the method get_table. Both plot and extract methods needs an argument index_name that indicates the table to be ploted or extarcted. Table \@ref(tab:CTDquerier-index) shows the relation between the possible options for index_name depeting of the query performed. Also the pssible representation of each table.

| Accessor | Genes | Chemicals | Diseases | |:-------------------------|:-----------------|:-----------------|:---------| | gene interactions | | heat-map/network | heat-map | | chemical interactions | heat-map | | heat-map | | diseases | heat-map | heat-map | | | gene-gene interactions | heat-map/network | | | | kegg pathways | network | heat-map | network | | go terms | network | heat-map | |

: (#tab:CTDquerier-index) Relation of the accessors and representation of each table in a CTDdata object depending of the input.

Querying CTDbase ...

... by gene

To query CTDbase for a given gene or set of genes, we use the function query_ctd_gene:

args( query_ctd_gene )

The argument terms is the one that must be filled with the list of genes of interest. The argument filename is filled with the name that will receive the table with the specific vocabulary from CTDbase for genes. The function checks if this file already exists, if is the case it used the local version. The argument mode is used to download the vocabulary file (for more info., check download.file from module utils). Finally, the argument verbose will show relevant messages about the querying process if is set to TRUE.

A typical gene-query follows:

ctd_genes <- query_ctd_gene( 
    terms = c( "APOE", "APOEB", "APOE2", "APOE3" , "APOE4", "APOA1", "APOA5" ),
    ask = FALSE,
    verbose = FALSE
)
ctd_genes

As can be seen, query_ctd_gene informs about the number of terms used in the query and the number of terms lost in the process. To know the exact terms that were found in CTDbase and the ones that were lost, we use the method get_terms.

get_terms( ctd_genes )

Extract Tables

Now that the information about the genes of interest was download from CTDbase we can access to it using the method get_table. Method extract allows to access to different tables according to the origin of the \texttt{CTDdata} object. For a \texttt{CTDdata} created from genes the accessible tables are:

| Table | Available | Accessors | |:-------------------------|:---------:|:---------------------------| | Gene Interactions | NO | "gene interactions" | | Chemicals Interactions | YES | "chemical interactions" | | Diseases | YES | "diseases" | | Gene-Gene Interactions | YES | "gene-gene interactions" | | Pathways (KEGG) | YES | "kegg pathways" | | GO (Gene Ontology Terms) | YES | "go terms" |

Example of how to extract one of this tables follows:

x <- get_table( ctd_genes , index_name = "diseases" )
if( nrow( x ) > 0 ) {
    x[ 1:2, 1:3 ]
}

The information stored in each table can be see in the following code, were the names of the columns of each table is shown:

colnames( get_table( ctd_genes, index_name = "chemical interactions" ) )
colnames( get_table( ctd_genes, index_name = "diseases" ) )
colnames( get_table( ctd_genes, index_name = "gene-gene interactions" ) )
colnames( get_table( ctd_genes, index_name = "kegg pathways" ) )
colnames( get_table( ctd_genes, index_name = "go terms" ) )

Plotting Gene Created CTDdata Objects

The generic plot function has the same mechanism that get_table. Using the argument index_name we select the table to plot. Then, the arguments subset.gene and subset.* (being * chemicals, diseases, pathways and go) allows to filter the X-axis and Y-axis. Depending the table to be plotted, the argument field.score can be used to select the field to plotted (that can takes "Inference" or "Reference" values). Then argument filter.score can be used to filter entries of the table. Finally, the argument max.length is in charge to reduce the characters of the labels.

The following plot shows the number of reference that cites the association between the APOE-like genes and chemicals.

plot( ctd_genes, index_name = "chemical interactions", filter.score = 3 )

Then, next plot shows shows the inference score that associates the APOE-like genes with diseases according to CTDbase.

plot( ctd_genes, index_name = "disease", filter.score = 115 )

The plot to explore the gene-gene interactions is based in a network representation. The genes from the original set are dark-coloured, while the other genes are light-coloured.

plot( ctd_genes, index_name = "gene-gene interactions", 
    representation = "network", main = "APOE-like gene-gene interactions" )

Finally both KEG pathways and GO terms related to the given set of genes can be also visually explored. for KEGG pathways:

plot( ctd_genes, index_name = "kegg pathways", 
    representation = "network", main = "KEGG pathways related to APOE genes" )

With idea to allow user to create clean networks, arguments subset.gene and subset.pathway can be used to filter genes and KEGG pathways. For GO term we use the same structure:

plot( ctd_genes, index_name = "go terms",
    representation = "network", main = "GO terms related to APOE genes",
    ontology = "Molecular Function" )

The argument ontology can take values "Biological Process", "Cellular Component" and "Molecular Function". One of them or any combination. This helps to filter the relation that will be plotted in the network. With the same idea, arguments subset.gene and subset.go can be used to filter genes and GO terms.

... by chemical

To query CTDbase for a given chemical or set of chemicals, we use the function query_ctd_chem:

args( query_ctd_chem )

The argument terms is the one that must be filled with the list of chemicals of interest. The argument filename is filled with the name that will receive the table with the specific vocabulary from CTDbase for chemicals. The function checks if this file already exists, if is the case it used the local version. The argument mode is used to download the vocabulary file (for more info., check download.file from module utils). Finally, the argument verbose will show relevant messages about the querying process if is set to TRUE.

A typical chemical-query follows:

ctd_chem <- query_ctd_chem( 
  terms = c( "Zinc", "Cadmium" ),
  ask = FALSE,
  verbose = FALSE
)
  ctd_chem

As can be seen, query_ctd_chem informs about the number of terms used in the query and the number of terms lost in the process. To know the exact terms that were found in CTDbase and the ones that were lost, we use the method get_terms.

get_terms( ctd_chem )

Extract Tables

Now that the information about the chemicals of interest was download from CTDbase we can access to it using the method get_table. Method extract allows to access to different tables according to the origin of the \texttt{CTDdata} object. For a \texttt{CTDdata} created from chemicals the accessible tables are:

| Table | Available | Accessors | |:-------------------------|:---------:|:---------------------------| | Gene Interactions | YES | "gene interactions" | | Chemicals Interactions | NO | "chemical interactions" | | Diseases | YES | "diseases" | | Gene-Gene Interactions | NO | "gene-gene interactions" | | Pathways (KEGG) | YES | "kegg pathways" | | GO (Gene Ontology Terms) | YES | "go terms" |

Example of how to extract one of this tables follows:

x <- get_table( ctd_chem , index_name = "diseases" )
if( nrow( x ) > 0 ) {
    x[ 1:2, 1:6 ]
}

The information stored in each table can be see in the following code, were the names of the columns of each table is shown:

colnames( get_table( ctd_chem, index_name = "gene interactions" ) )
colnames( get_table( ctd_chem, index_name = "diseases" ) )
colnames( get_table( ctd_chem, index_name = "kegg pathways" ) )
colnames( get_table( ctd_chem, index_name = "go terms" ) )

Plotting Chemical Created CTDdata Objects

The generic plot function seen in the previous sections for gene queries also works with the chemical queries. The arguments that can be used are the same when plotting both types of queries.

The following plot shows the inference score for each chemical-gene association according to CTDbase.

plot( ctd_chem, index_name = "gene interactions", filter.score = 5 )

This associations, or relations, can be further inspected in a network representation that includes the effect of the chemical on the altered genes.

plot( ctd_chem, index_name = "gene interactions", representation = "network",
    filter.score = 3, main = "Gen-Chemical interaction for Zinc and Cadmium" )

Consequently, a heat-map with the inference score for the associations between chemicals and diseases can also be plotted.

plot( ctd_chem, index_name = "disease" )

The association between KEGG pathways and chemicals can be seen as a heat-map. The heat-map shows the P-Value of the association between each pathway and each chemical.

plot( ctd_chem, index_name = "kegg pathways", filter.score = 1e-40 )

The argument filter.score can be used to filter associations by their P-Value. Only the associations with a -Value lower or equal to the value given to filter.score are keep. Then, the heat-map calculates the terciles of the distribution of P-Values to create the legend (that has always four categories).

The heat-map for GO terms follows the same mechanic:

plot( ctd_chem, index_name = "go terms",
    representation = "network", filter.score = 1e-210 )

... by disease

To query CTDbase for a given disease or set of diseases, we use the function query_ctd_dise:

args( query_ctd_dise )

The argument terms is the one that must be filled with the list of diseases of interest. The argument filename is filled with the name that will receive the table with the specific vocabulary from CTDbase for diseases. The function checks if this file already exists, if is the case it used the local version. The argument mode is used to download the vocabulary file (for more info., check download.file from module utils). Finally, the argument verbose will show relevant messages about the querying process if is set to TRUE.

A typical gene-query follows:

ctd_diseases <- query_ctd_dise( 
  terms = c( "Dementia", "Alzheimer" ),
  ask = FALSE,
  verbose = FALSE
)
ctd_diseases

As can be seen, query_ctd_chem informs about the number of terms used in the query and the number of terms lost in the process. To know the exact terms that were found in CTDbase and the ones that were lost, we use the method get_terms.

get_terms( ctd_diseases )

Extract Tables

Now that the information about the diseases of interest was download from CTDbase we can access to it using the method get_table. Method extract allows to access to different tables according to the origin of the \texttt{CTDdata} object. For a \texttt{CTDdata} created from diseases the accessible tables are:

| Table | Available | Accessors | |:-------------------------|:---------:|:---------------------------| | Gene Interactions | YES | "gene interactions" | | Chemicals Interactions | YES | "chemical interactions" | | Diseases | NO | "diseases" | | Gene-Gene Interactions | NO | "gene-gene interactions" | | Pathways (KEGG) | YES | "kegg pathways" | | GO (Gene Ontology Terms) | NO | "go terms" |

x <- get_table( ctd_diseases , index_name = "gene interactions" )
if( nrow( x ) > 0 ) {
    x[ 1:2, 1:5 ]
}

The information stored in each table can be see in the following code, were the names of the columns of each table is shown:

colnames( get_table( ctd_diseases, index_name = "gene interactions" ) )
colnames( get_table( ctd_diseases, index_name = "chemical interactions" ) )
colnames( get_table( ctd_diseases, index_name = "kegg pathways" ) )

Plotting Disease Created CTDdata Objects

As seen in the previous sections CTDquerier allows for basic visualization from disease-retrieved information from CTDbase. The function plot is also used on disease created CTDdata objects allowing to display the disease-gene interaction tables, the disease-chemical interaction table and the pathway related to disease table.

Disease created CTDdata objects have a heat-map visualization of the disease interaction with chemicals. This plot allows to select the CTDbase's inference score or the number of reference to highlight the associations.

plot( ctd_diseases, index_name = "gene interactions", filter.score = 75 )

Then, the associations between diseases and chemicals can also be plotted. Usually this plot is a heat-map as previously seen for genes. Nevertheless the lot can result in a bar-plot. This happens when the argument filter.core that allows to filter the associations (selecting any of CTDbase's inference score or number of reference for the association) is so string that only a single disease is kept.

plot( ctd_diseases, index_name = "chemical interactions", filter.score = 35 )

Finally a network for the KEGG pathways inferred for the diseases can also be obtained.

plot( ctd_diseases, index_name = "kegg pathways", 
    representation = "network", subset.disease = "Dementia" )

Session Info.

sessionInfo()

Bibliography

isglobal-brge/CTDquerier documentation built on Oct. 6, 2022, 1:18 p.m.