| Title: | Pathway Analysis with Down-weighting of Overlapping Genes (PADOG) |
|---|---|
| Description: | This package implements a general purpose gene set analysis method called PADOG that downplays the importance of genes that appear often accross the sets of genes to be analyzed. The package provides also a benchmark for gene set analysis methods in terms of sensitivity and ranking using 42 datasets originally curated in KEGGdzPathwaysGEO and KEGGandMetacoreDzPathwaysGEO data packages. |
| Authors: | Adi Laurentiu Tarca <[email protected]>; Zhonghui Xu <[email protected]>; Gaurav Bhatti <[email protected]> |
| Maintainer: | Adi L. Tarca <[email protected]> |
| License: | GPL (>= 2) |
| Version: | 1.55.1 |
| Built: | 2026-11-18 14:04:44 UTC |
| Source: | https://github.com/bioc/PADOG |
This is a general purpose function to compare a given gene set analysis method in terms of sensitivity and ranking agains PADOG and GSA (if installed) using 24 public datasets.
compPADOG(datasets=NULL,collection="KEGGdzPathwaysGEO",existingMethods=c("GSA","PADOG"),mymethods=NULL,gslist = NULL,gs.names=NULL,Nmin=3,NI=1000,parallel=TRUE, ncr=NULL, pkgs=NULL, expVars=NULL, dseed=NULL, plots=FALSE,verbose=FALSE)compPADOG(datasets=NULL,collection="KEGGdzPathwaysGEO",existingMethods=c("GSA","PADOG"),mymethods=NULL,gslist = NULL,gs.names=NULL,Nmin=3,NI=1000,parallel=TRUE, ncr=NULL, pkgs=NULL, expVars=NULL, dseed=NULL, plots=FALSE,verbose=FALSE)
datasets |
A character vector with valid names of datasets to use among all 42 datasets availble via loadCompPADOGBenchmark and availble at https://zenodo.org/records/23192308. If left NULL, the argument collection is used to determine what datasets will be used. |
collection |
A character string specifying the benchmark data collection to use. Valid values are |
existingMethods |
A character vector with one or more of the predefined methods c("GSA","PADOG"). The first is used as reference method. |
mymethods |
A list whose elements are valid functions implementing gene set analysis methods. See the example to see what arguments the functions have to take in and what kind of output they need to produce. |
gslist |
A list with the gene sets. (see also |
gs.names |
A character vector giving additional information about each gene set. For instance when gene seta are pathways, the full name of the pathway would be a meaningful gene set name. |
Nmin |
The minimum size of gene sets to be included in the analysis for all methods. |
NI |
Number of iterations to determine the gene set score significance p-values in PADOG and GSA methods. |
parallel |
Should paralell be used if multiple cores are available and the package parallel is available. If set to TRUE analyses on methods and datasets will be run on on multiple CPU at a time. |
ncr |
The number of CPU cores used when |
pkgs |
Character vector of packages that the |
expVars |
Character vector of variables to export. Consult the |
dseed |
Optional initial seed for random number generator (integer) used in |
plots |
If set to TRUE will plot the ranks of the target genesets and the ranks differences between a methods and the reference method. |
verbose |
This argument will be passed to PADOG and AbsmT methods. If set to TRUE it will show the interations performed so far. |
See cited documents for more details.
A data list of stats from comparing the methods on the bechmark. The summary component is a data frame containing the columns:
Method is the name of the geneset analysis method;
p geomean geometric mean of nominal p-values for the target genesets (genesets expected to be relevant);
p med median of nominal p-values for the target genesets;
% p<0.05 is the fraction of target genesets significant at 0.05 level (this is the sensitivity);
% q<0.05 is the fraction of target genesets significant at 0.05 level after FDR correction;
rank mean mean rank of the target genesets;
rank med median rank of the target genesets;
p Wilcox. p value from a Wilcoxon test paired at dataset level comparing the rank of target genesets ;
p LME p value from a linear mixed effects (LME) model which unlike the Wilcoxon test above accounts for the fact that ranks for the same pathway may be correlated;
coef LME Coefficient from the LME model giving the difference in ranks of the target genesets between the current geneset analysis Method and the reference method
chose to be the first method in the existingMethods argument;
Adi Laurentiu Tarca <[email protected]>
Adi L. Tarca, Sorin Draghici, Gaurav Bhatti, Roberto Romero, Down-weighting overlapping genes improves gene set analysis, BMC Bioinformatics, 13(136), 2012.
Adi L. Tarca, Gaurav Bhatti, Roberto Romero, A Comparison of Gene Set Analysis Methods in Terms of Sensitivity, Prioritization and Specificity, PLoS One. 8(11), 2013.
#compare a new geneset analysis method with established methods PADOG and GSA #define your new gene set analysis method that takes as input: #set- the name of dataset provided by loadCompPADOGBenchmark function #mygslist - a list with the genesets #minsize- minimum number of genes in a geneset to be considered for analysis randomF=function(set,mygslist,minsize){ set.seed(1) #this loads the dataset in an ExpressionSet object called x loadCompPADOGBenchmark(set) x=get(set) #Extract from the dataset the required info to be passed to filteranot and enrichment exp=experimentData(x); dat.m=exprs(x) ano=pData(x) dataset= exp@name design= notes(exp)$design annotation= paste(x@annotation,".db",sep="") targetGeneSets= notes(exp)$targetGeneSets #get rid of duplicates probesets per ENTREZ ID by keeping the probeset #with smallest p-value (computed using limma) aT1=filteranot(esetm=dat.m,group=ano$Group,paired=(design=="Paired"), block=ano$Block,annotation=annotation) #create an output dataframe for this toy method with random gene set p-values mygslistSize=unlist(lapply(mygslist,function(x){length(intersect(aT1$ENTREZID,x))})) res=data.frame(ID=names(mygslist),P=runif(length(mygslist)), Size=mygslistSize,stringsAsFactors=FALSE) res$FDR=p.adjust(res$P,"fdr") #drop genesets with less than minsize genes in the current dataset res=res[res$Size>=minsize,] #compute ranks res$Rank=rank(res$P)/dim(res)[1]*100 #needed to compare ranks between methods; must be the same as given #in mymethods argument "list(myRand=" res$Method="myRand"; #needed because comparisons of ranks between methods is paired at dataset level res$Dataset<-dataset; #output only result for the targetGeneSets #which are gene sets expected to be relevant in this dataset return(res[res$ID %in% targetGeneSets,]) } #prepare KEGG pathways for human as gene list library(KEGGREST) res <- keggLink("pathway", "hsa") a=data.frame(path=gsub(paste("path:","hsa",sep=""),"",res),gns=gsub(paste("hsa",":",sep=""),"",names(res))) gslist=tapply(a$gns,a$path,function(x){as.character(x)}) gs.names=keggList("pathway", "hsa")[paste("hsa",names(gslist),sep="")] names(gs.names)<-names(gslist) #compare myRand against PADOG on 3 datasets only mysets=c("GSE9348","GSE8671","GSE1297") out=compPADOG(datasets=mysets,existingMethods=c("PADOG"), mymethods=list(myRand=randomF), gslist=gslist,Nmin=3,NI=100,plots=FALSE,verbose=FALSE)#compare a new geneset analysis method with established methods PADOG and GSA #define your new gene set analysis method that takes as input: #set- the name of dataset provided by loadCompPADOGBenchmark function #mygslist - a list with the genesets #minsize- minimum number of genes in a geneset to be considered for analysis randomF=function(set,mygslist,minsize){ set.seed(1) #this loads the dataset in an ExpressionSet object called x loadCompPADOGBenchmark(set) x=get(set) #Extract from the dataset the required info to be passed to filteranot and enrichment exp=experimentData(x); dat.m=exprs(x) ano=pData(x) dataset= exp@name design= notes(exp)$design annotation= paste(x@annotation,".db",sep="") targetGeneSets= notes(exp)$targetGeneSets #get rid of duplicates probesets per ENTREZ ID by keeping the probeset #with smallest p-value (computed using limma) aT1=filteranot(esetm=dat.m,group=ano$Group,paired=(design=="Paired"), block=ano$Block,annotation=annotation) #create an output dataframe for this toy method with random gene set p-values mygslistSize=unlist(lapply(mygslist,function(x){length(intersect(aT1$ENTREZID,x))})) res=data.frame(ID=names(mygslist),P=runif(length(mygslist)), Size=mygslistSize,stringsAsFactors=FALSE) res$FDR=p.adjust(res$P,"fdr") #drop genesets with less than minsize genes in the current dataset res=res[res$Size>=minsize,] #compute ranks res$Rank=rank(res$P)/dim(res)[1]*100 #needed to compare ranks between methods; must be the same as given #in mymethods argument "list(myRand=" res$Method="myRand"; #needed because comparisons of ranks between methods is paired at dataset level res$Dataset<-dataset; #output only result for the targetGeneSets #which are gene sets expected to be relevant in this dataset return(res[res$ID %in% targetGeneSets,]) } #prepare KEGG pathways for human as gene list library(KEGGREST) res <- keggLink("pathway", "hsa") a=data.frame(path=gsub(paste("path:","hsa",sep=""),"",res),gns=gsub(paste("hsa",":",sep=""),"",names(res))) gslist=tapply(a$gns,a$path,function(x){as.character(x)}) gs.names=keggList("pathway", "hsa")[paste("hsa",names(gslist),sep="")] names(gs.names)<-names(gslist) #compare myRand against PADOG on 3 datasets only mysets=c("GSE9348","GSE8671","GSE1297") out=compPADOG(datasets=mysets,existingMethods=c("PADOG"), mymethods=list(myRand=randomF), gslist=gslist,Nmin=3,NI=100,plots=FALSE,verbose=FALSE)
This function helps to deal with multiple probesets/probes per gene prior to geneset analysis.
filteranot(esetm=NULL,group=NULL,paired=FALSE,block=NULL,annotation=NULL,include.details=FALSE)filteranot(esetm=NULL,group=NULL,paired=FALSE,block=NULL,annotation=NULL,include.details=FALSE)
esetm |
A matrix containing log transfomed and normalized gene expression data. Rows correspond to genes and columns to samples. Rownames of esetm need to be valid probeset or probe names. |
group |
A character vector with the class labels of the samples. It can only contain "c" for control samples or "d" for disease samples. |
paired |
A logical value to indicate if the samples in the two groups are paired. |
block |
A character vector indicating the block ids of the samples classified by the group variable, if |
annotation |
A valid chip annotation package name (e.g. "hgu133plus2.db") |
include.details |
If set to true, will include all columns from limma's topTable for this dataset. |
See cited documents for more details.
A data frame containing the probeset IDs (and corresponding ENTREZ IDs) of the best probesets for each gene ;
Adi Laurentiu Tarca <[email protected]>
Adi L. Tarca, Sorin Draghici, Gaurav Bhatti, Roberto Romero, Down-weighting overlapping genes improves gene set analysis, BMC Bioinformatics, 2012, submitted.
Adi L. Tarca, Gaurav Bhatti, Roberto Romero, A Comparison of Gene Set Analysis Methods in Terms of Sensitivity, Prioritization and Specificity, PLoS One. 8(11), 2013.
#run padog on a colorectal cancer dataset of the 24 datasets benchmark GSE9348 set="GSE9348" loadCompPADOGBenchmark(set) x=get(set) #Extract from the dataset the required info exp=experimentData(x); dataset= exp@name dat.m=exprs(x) ano=pData(x) design= notes(exp)$design annotation= paste(x@annotation,".db",sep="") dim(dat.m) #get rid of duplicates in the same way as is done for PADOG and assign probesets to ENTREZ IDS #get rid of duplicates by choosing the probe(set) with lowest p-value; get ENTREZIDs for probes aT1=filteranot(esetm=dat.m,group=ano$Group,paired=(design=="Paired"),block=ano$Block,annotation) #filtered expression matrix filtexpr=dat.m[rownames(dat.m)%in%aT1$ID,] dim(filtexpr)#run padog on a colorectal cancer dataset of the 24 datasets benchmark GSE9348 set="GSE9348" loadCompPADOGBenchmark(set) x=get(set) #Extract from the dataset the required info exp=experimentData(x); dataset= exp@name dat.m=exprs(x) ano=pData(x) design= notes(exp)$design annotation= paste(x@annotation,".db",sep="") dim(dat.m) #get rid of duplicates in the same way as is done for PADOG and assign probesets to ENTREZ IDS #get rid of duplicates by choosing the probe(set) with lowest p-value; get ENTREZIDs for probes aT1=filteranot(esetm=dat.m,group=ano$Group,paired=(design=="Paired"),block=ano$Block,annotation) #filtered expression matrix filtexpr=dat.m[rownames(dat.m)%in%aT1$ID,] dim(filtexpr)
This function loads datasets needed to benchmark gene set analysis methods from data packages KEGGdzPathwaysGEO and KEGGandMetacoreDzPathwaysGEO.
loadCompPADOGBenchmark(dataset = NULL, collection = NULL,envir = parent.frame(),assign=TRUE)loadCompPADOGBenchmark(dataset = NULL, collection = NULL,envir = parent.frame(),assign=TRUE)
dataset |
A character vector specifying the dataset(s) to load. Dataset names must
correspond to datasets available in the collection(s) specified by
|
collection |
A character string specifying the benchmark data collection to use.
Valid values are |
envir |
The environment into which the requested dataset(s) are loaded.
Defaults to |
assign |
If TRUE the requested dataset(s) are loaded, if not, just the names of the datasets that could be loaded given the dataset and collection arguments. |
See cited documents for more details.
Invisibly returns the names of the datasets (as ExpressionSet) successfully loaded into
envir if assig is TRUE.
The key elements to extract from each dataset in order to perform gene set enrichment analysis and use the results in the benchmark are shown in the example below.
Adi Laurentiu Tarca <[email protected]>
Adi L. Tarca, Sorin Draghici, Gaurav Bhatti, Roberto Romero, Down-weighting overlapping genes improves gene set analysis, BMC Bioinformatics, 13(136), 2012.
Adi L. Tarca, Gaurav Bhatti, Roberto Romero, A Comparison of Gene Set Analysis Methods in Terms of Sensitivity, Prioritization and Specificity, PLoS One. 8(11), 2013.
Falcon, S., Morgan, M., and Gentleman, R. (2007), An Introduction to Bioconductor's ExpressionSet Class.
## Load one dataset from the KEGGdzPathwaysGEO collection loadCompPADOGBenchmark(dataset = "GSE1297",collection = "KEGGdzPathwaysGEO") ## Load one dataset from the KEGGandMetacoreDzPathwaysGEO collection loadCompPADOGBenchmark(dataset = "GSE1145",collection = "KEGGandMetacoreDzPathwaysGEO") x = get("GSE1297") exp = experimentData(x) dataset = exp@name #name of dataset disease = notes(exp)$disease # name of the disease condition dat.m = exprs(x) #name of log2 gene expression matrix ready for analysis ano = pData(x) #data frame with Group information for differential abudnance analysis design = notes(exp)$design # variable specifying the design of the study (paired or not) annotation = paste(x@annotation, ".db", sep = "") # microarray platform targetGeneSets = notes(exp)$targetGeneSets #ID of KEGG pathway assumed to be relevant for the disease in question #name of the KEGG pathway for that ID KEGGREST::keggGet(paste("path:hsa",targetGeneSets,sep=""))[[1]]$NAME## Load one dataset from the KEGGdzPathwaysGEO collection loadCompPADOGBenchmark(dataset = "GSE1297",collection = "KEGGdzPathwaysGEO") ## Load one dataset from the KEGGandMetacoreDzPathwaysGEO collection loadCompPADOGBenchmark(dataset = "GSE1145",collection = "KEGGandMetacoreDzPathwaysGEO") x = get("GSE1297") exp = experimentData(x) dataset = exp@name #name of dataset disease = notes(exp)$disease # name of the disease condition dat.m = exprs(x) #name of log2 gene expression matrix ready for analysis ano = pData(x) #data frame with Group information for differential abudnance analysis design = notes(exp)$design # variable specifying the design of the study (paired or not) annotation = paste(x@annotation, ".db", sep = "") # microarray platform targetGeneSets = notes(exp)$targetGeneSets #ID of KEGG pathway assumed to be relevant for the disease in question #name of the KEGG pathway for that ID KEGGREST::keggGet(paste("path:hsa",targetGeneSets,sep=""))[[1]]$NAME
This is a general purpose gene set analysis method that downplays the importance of genes that apear often accross the sets of genes analyzed. The package provides also a benchmark for gene set analysis in terms of sensitivity and ranking using 42 public datasets.
padog(esetm=NULL,group=NULL,paired=FALSE,block=NULL,gslist=NULL,gs.names=NULL, annotation=NULL,NI=1000,plots=FALSE,targetgs=NULL,Nmin=3, verbose=TRUE,parallel=FALSE,dseed=NULL,ncr=NULL)padog(esetm=NULL,group=NULL,paired=FALSE,block=NULL,gslist=NULL,gs.names=NULL, annotation=NULL,NI=1000,plots=FALSE,targetgs=NULL,Nmin=3, verbose=TRUE,parallel=FALSE,dseed=NULL,ncr=NULL)
esetm |
A matrix containing log transfomed and normalized gene expression data. Rows correspond to genes and columns to samples. |
group |
A character vector with the class labels of the samples. It can only contain "c" for control samples or "d" for disease samples. |
paired |
A logical value to indicate if the samples in the two groups are paired. |
block |
A character vector indicating the block ids of the samples classified by the group variable, if |
gslist |
A list with the gene sets. Each element of the list should be a character vector with the identifiers for the genes. The identifiers can be probe(sets)
ids if the |
gs.names |
Character vector with the names of the gene sets. If specified, must have the same length as gslist. |
annotation |
A valid chip annotation package if the rownames of |
NI |
Number of iterations to determine the gene set score significance p-values. |
plots |
If set to TRUE then the distribution of the PADOG scores with and without weighting the genes in raw and standardized form are shown using boxplots.
A pdf file will be created in the current directory having the name provided in the |
targetgs |
The identifier of a traget gene set for which the scores will be highlighted in the plots produced if |
Nmin |
The minimum size of gene sets to be included in the analysis. |
verbose |
If set to TRUE, displays the number of iterations elapsed is displayed. |
parallel |
If set to TRUE, the |
dseed |
Optional initial seed for random number generator (integer). |
ncr |
The number of CPU cores used when |
See cited documents for more details.
A data frame containing the ranked pathways and various statistics: Name is the name of the gene set;
ID is the gene set identifier; Size is the number of genes in the geneset; meanAbsT0 is the mean of absolute t-scores;
padog0 is the mean of weighted absolute t-scores;
PmeanAbsT significance of the meanAbsT0; Ppadog is the significance of the padog0 score;
Adi Laurentiu Tarca <[email protected]>
Adi L. Tarca, Sorin Draghici, Gaurav Bhatti, Roberto Romero, Down-weighting overlapping genes improves gene set analysis, BMC Bioinformatics, 13(136), 2012.
Adi L. Tarca, Gaurav Bhatti, Roberto Romero, A Comparison of Gene Set Analysis Methods in Terms of Sensitivity, Prioritization and Specificity, PLoS One. 8(11), 2013.
#run padog on a colorectal cancer dataset, GSE9348 #use NI=1000 for accurate results. set="GSE9348" loadCompPADOGBenchmark(set,collection="KEGGdzPathwaysGEO") x=get(set) #Extract from the dataset the required info exp=experimentData(x); dataset= exp@name dat.m=exprs(x) ano=pData(x) design= notes(exp)$design annotation= paste(x@annotation,".db",sep="") targetGeneSets= notes(exp)$targetGeneSets #prepare KEGG pathways for human as gene list library(KEGGREST) res <- keggLink("pathway", "hsa") a=data.frame(path=gsub(paste("path:","hsa",sep=""),"",res),gns=gsub(paste("hsa",":",sep=""),"",names(res))) gslist=tapply(a$gns,a$path,function(x){as.character(x)}) gs.names=keggList("pathway", "hsa")[paste("hsa",names(gslist),sep="")] names(gs.names)<-names(gslist) myr=padog( esetm=dat.m, group=ano$Group, paired=design=="Paired", block=ano$Block, targetgs=targetGeneSets, annotation=annotation, gslist=gslist, gs.names=gs.names, verbose=TRUE, Nmin=3, NI=100, plots=FALSE, parallel = TRUE, dseed=1) myr$Name = gsub("- Homo sapiens (human)", "", myr$Name, fixed = TRUE) myr[1:20,]#run padog on a colorectal cancer dataset, GSE9348 #use NI=1000 for accurate results. set="GSE9348" loadCompPADOGBenchmark(set,collection="KEGGdzPathwaysGEO") x=get(set) #Extract from the dataset the required info exp=experimentData(x); dataset= exp@name dat.m=exprs(x) ano=pData(x) design= notes(exp)$design annotation= paste(x@annotation,".db",sep="") targetGeneSets= notes(exp)$targetGeneSets #prepare KEGG pathways for human as gene list library(KEGGREST) res <- keggLink("pathway", "hsa") a=data.frame(path=gsub(paste("path:","hsa",sep=""),"",res),gns=gsub(paste("hsa",":",sep=""),"",names(res))) gslist=tapply(a$gns,a$path,function(x){as.character(x)}) gs.names=keggList("pathway", "hsa")[paste("hsa",names(gslist),sep="")] names(gs.names)<-names(gslist) myr=padog( esetm=dat.m, group=ano$Group, paired=design=="Paired", block=ano$Block, targetgs=targetGeneSets, annotation=annotation, gslist=gslist, gs.names=gs.names, verbose=TRUE, Nmin=3, NI=100, plots=FALSE, parallel = TRUE, dseed=1) myr$Name = gsub("- Homo sapiens (human)", "", myr$Name, fixed = TRUE) myr[1:20,]