makeGPS {sigora} | R Documentation |
Create your own Signature Object.
Description
Given a repository of gene-pathway associations either in a tab delimited
file with three columns (pathwayID,pathway Description,Gene) or a
corresponding dataframe, this function identifies all Gene Pair Signatures
(pairs of genes that are as a combination unique to a single pathway) and
Pathway Unique Genes (genes that are uniquely associated with a single
pathway) and stores them in a format that is usable by sigora
.
Please also see the "details" and "note" sections below.
Usage
makeGPS(
pathwayTable = NULL,
fn = NULL,
maxLevels = 5,
saveFile = NULL,
repoName = "userrepo",
maxFunperGene = 100,
maxGenesperPathway = 500,
minGenesperPathway = 10
)
Arguments
pathwayTable |
A data frame describing gene-pathway associations in following format: pathwayID,pathwayName,Gene. Either pathwayTable or fn should be provided. |
fn |
Where to find the repository.Either pathwayTable or fn should be provided. |
maxLevels |
For hierarchical repositories, the number of levels to consider. |
saveFile |
Where to save the object as an rda file. |
repoName |
Repository name. |
maxFunperGene |
A cutoff threshold, genes with more than this number of associated pathways are excluded to speed up the GPS identification process. |
maxGenesperPathway |
A cutoff threshold, pathways with more than this number of associated genes are excluded to speed up the GPS identification process. |
minGenesperPathway |
A cutoff threshold, pathways with less than this number of associated genes are excluded to speed up the GPS identification process. |
Details
The primary purpose of makeGPS
is to convert a user-supplied
gene-pathway association table to a repository of weighted Gene Pair
Signatures (GPS) that are unique features of pathways. Such GPS can than be
used for signature (gene-pair) based analyses using sigora
.
Additionally, the resulting object also retains the original "single
gene"-"pathway" associations for the purpose of followup analyses, such as
comparison of sigora-results to traditional methods. ora
is an
implementation of the traditional (individual gene) Overrepresentation
Analysis.
Value
A GPS repository, to be used by sigora
and ora.
Note
This function relies on package slam
, which should be installed
from CRAN. It is fairly memory intensive, and it is recommended to be run
on a machine with at least 6GB of RAM. Also, make sure to save and reuse the
resulting GPS repository in future analyses!
References
Foroushani AB, Brinkman FS and Lynn DJ (2013).“Pathway-GPS and SIGORA: identifying relevant pathways based on the over-representation of their gene-pair signatures.”PeerJ, 1
See Also
Examples
data(nciTable); data(idmap)
## what the input looks like:
head(nciTable)
## create a SigObject. use the saveFile parameter for reuse.
nciH<-makeGPS(pathwayTable=load_data('nciTable'))
ils<-grep("^IL",idmap[,"Symbol"],value=TRUE)
ilnci<-sigora(queryList=ils,GPSrepo=nciH,level=3)