... | ... |
@@ -5,11 +5,17 @@ |
5 | 5 |
\title{For a given gmt file of a specific pathway database, pathway enrichment |
6 | 6 |
can be performed. Function supports Entrez ID and symbol based gmt file.} |
7 | 7 |
\usage{ |
8 |
-pathwayEnrichment(genes, gmtFile, org_assembly = c("hg19", "hg38", |
|
9 |
- "mm10", "dre10", "rn6", "dm6", "ce11", "sc3"), pCut = 0.05, |
|
10 |
- pAdjCut = 0.05, pAdjust = c("holm", "hochberg", "hommel", |
|
11 |
- "bonferroni", "BH", "BY", "fdr", "none"), isSymbol, min = 5, |
|
12 |
- isGeneEnrich = FALSE) |
|
8 |
+pathwayEnrichment( |
|
9 |
+ genes, |
|
10 |
+ gmtFile, |
|
11 |
+ org_assembly = c("hg19", "hg38", "mm10", "dre10", "rn6", "dm6", "ce11", "sc3"), |
|
12 |
+ pCut = 0.05, |
|
13 |
+ pAdjCut = 0.05, |
|
14 |
+ pAdjust = c("holm", "hochberg", "hommel", "bonferroni", "BH", "BY", "fdr", "none"), |
|
15 |
+ isSymbol, |
|
16 |
+ min = 5, |
|
17 |
+ isGeneEnrich = FALSE |
|
18 |
+) |
|
13 | 19 |
} |
14 | 20 |
\arguments{ |
15 | 21 |
\item{genes}{Input genes} |
... | ... |
@@ -46,12 +52,3 @@ Pathway Enrichment |
46 | 52 |
For a given gmt file of a specific pathway database, pathway enrichment |
47 | 53 |
can be performed. Function supports Entrez ID and symbol based gmt file. |
48 | 54 |
} |
49 |
-\examples{ |
|
50 |
- |
|
51 |
-wp.gmt <-rWikiPathways::downloadPathwayArchive( |
|
52 |
- organism = "Homo sapiens",format = "gmt") |
|
53 |
-a <- pathwayEnrichment(genes = breastmRNA[1:100,], gmtFile = wp.gmt, |
|
54 |
- org_assembly = 'hg19',isGeneEnrich = FALSE, |
|
55 |
- isSymbol = FALSE) |
|
56 |
- |
|
57 |
-} |
... | ... |
@@ -2,8 +2,8 @@ |
2 | 2 |
% Please edit documentation in R/pathway.R |
3 | 3 |
\name{pathwayEnrichment} |
4 | 4 |
\alias{pathwayEnrichment} |
5 |
-\title{For a given gmt file of a specific pathway database, pathway enrichment can |
|
6 |
-be performed. Function supports Entrez ID and symbol based gmt file.} |
|
5 |
+\title{For a given gmt file of a specific pathway database, pathway enrichment |
|
6 |
+can be performed. Function supports Entrez ID and symbol based gmt file.} |
|
7 | 7 |
\usage{ |
8 | 8 |
pathwayEnrichment(genes, gmtFile, org_assembly = c("hg19", "hg38", |
9 | 9 |
"mm10", "dre10", "rn6", "dm6", "ce11", "sc3"), pCut = 0.05, |
... | ... |
@@ -43,8 +43,8 @@ performed} |
43 | 43 |
Pathway Enrichment |
44 | 44 |
} |
45 | 45 |
\description{ |
46 |
-For a given gmt file of a specific pathway database, pathway enrichment can |
|
47 |
-be performed. Function supports Entrez ID and symbol based gmt file. |
|
46 |
+For a given gmt file of a specific pathway database, pathway enrichment |
|
47 |
+can be performed. Function supports Entrez ID and symbol based gmt file. |
|
48 | 48 |
} |
49 | 49 |
\examples{ |
50 | 50 |
|
... | ... |
@@ -50,8 +50,8 @@ be performed. Function supports Entrez ID and symbol based gmt file. |
50 | 50 |
|
51 | 51 |
wp.gmt <-rWikiPathways::downloadPathwayArchive( |
52 | 52 |
organism = "Homo sapiens",format = "gmt") |
53 |
-a <- pathwayEnrichment(genes = breastmRNA[1:100,], gmtFile = wp.gmt, |
|
54 |
- org_assembly = 'hg19',isGeneEnrich = FALSE, |
|
55 |
- isSymbol = FALSE) |
|
53 |
+a <- pathwayEnrichment(genes = breastmRNA[1:100,], gmtFile = wp.gmt, |
|
54 |
+ org_assembly = 'hg19',isGeneEnrich = FALSE, |
|
55 |
+ isSymbol = FALSE) |
|
56 | 56 |
|
57 | 57 |
} |
... | ... |
@@ -46,3 +46,12 @@ Pathway Enrichment |
46 | 46 |
For a given gmt file of a specific pathway database, pathway enrichment can |
47 | 47 |
be performed. Function supports Entrez ID and symbol based gmt file. |
48 | 48 |
} |
49 |
+\examples{ |
|
50 |
+ |
|
51 |
+wp.gmt <-rWikiPathways::downloadPathwayArchive( |
|
52 |
+ organism = "Homo sapiens",format = "gmt") |
|
53 |
+a <- pathwayEnrichment(genes = breastmRNA[1:100,], gmtFile = wp.gmt, |
|
54 |
+ org_assembly = 'hg19',isGeneEnrich = FALSE, |
|
55 |
+ isSymbol = FALSE) |
|
56 |
+ |
|
57 |
+} |
... | ... |
@@ -2,7 +2,7 @@ |
2 | 2 |
% Please edit documentation in R/pathway.R |
3 | 3 |
\name{pathwayEnrichment} |
4 | 4 |
\alias{pathwayEnrichment} |
5 |
-\title{For a given gmt file of a specific pathway database, pathway enrichment can |
|
5 |
+\title{For a given gmt file of a specific pathway database, pathway enrichment can |
|
6 | 6 |
be performed. Function supports Entrez ID and symbol based gmt file.} |
7 | 7 |
\usage{ |
8 | 8 |
pathwayEnrichment(genes, gmtFile, org_assembly = c("hg19", "hg38", |
... | ... |
@@ -16,33 +16,33 @@ pathwayEnrichment(genes, gmtFile, org_assembly = c("hg19", "hg38", |
16 | 16 |
|
17 | 17 |
\item{gmtFile}{File path of the gmt file} |
18 | 18 |
|
19 |
-\item{org_assembly}{Genome assembly of interest for the analysis. Possible |
|
20 |
-assemblies are "mm10" for mouse, "dre10" for zebrafish, "rn6" for rat, |
|
21 |
-"dm6" for fruit fly, "ce11" for worm, "sc3" for yeast, "hg19" and |
|
19 |
+\item{org_assembly}{Genome assembly of interest for the analysis. Possible |
|
20 |
+assemblies are "mm10" for mouse, "dre10" for zebrafish, "rn6" for rat, |
|
21 |
+"dm6" for fruit fly, "ce11" for worm, "sc3" for yeast, "hg19" and |
|
22 | 22 |
"hg38" for human} |
23 | 23 |
|
24 | 24 |
\item{pCut}{Threshold value for the pvalue. Default value is 0.05} |
25 | 25 |
|
26 |
-\item{pAdjCut}{Cutoff value for the adjusted p-values using one of given |
|
26 |
+\item{pAdjCut}{Cutoff value for the adjusted p-values using one of given |
|
27 | 27 |
method. Default value is 0.05.} |
28 | 28 |
|
29 |
-\item{pAdjust}{Methods of the adjusted p-values. Possible methods are |
|
29 |
+\item{pAdjust}{Methods of the adjusted p-values. Possible methods are |
|
30 | 30 |
"holm", "hochberg", "hommel", "bonferroni", "BH", "BY","fdr", "none"} |
31 | 31 |
|
32 | 32 |
\item{isSymbol}{Boolean value that controls the gene formats. If it is TRUE, |
33 |
-gene format of the gmt file should be symbol. Otherwise, gene format |
|
33 |
+gene format of the gmt file should be symbol. Otherwise, gene format |
|
34 | 34 |
must be ENTREZ ID.} |
35 | 35 |
|
36 |
-\item{min}{Minimum number of genes that are required for enrichment. By |
|
36 |
+\item{min}{Minimum number of genes that are required for enrichment. By |
|
37 | 37 |
default, it is set to 5.} |
38 | 38 |
|
39 |
-\item{isGeneEnrich}{Boolean value whether gene enrichment should be |
|
39 |
+\item{isGeneEnrich}{Boolean value whether gene enrichment should be |
|
40 | 40 |
performed} |
41 | 41 |
} |
42 | 42 |
\value{ |
43 | 43 |
Pathway Enrichment |
44 | 44 |
} |
45 | 45 |
\description{ |
46 |
-For a given gmt file of a specific pathway database, pathway enrichment can |
|
46 |
+For a given gmt file of a specific pathway database, pathway enrichment can |
|
47 | 47 |
be performed. Function supports Entrez ID and symbol based gmt file. |
48 | 48 |
} |
... | ... |
@@ -2,40 +2,47 @@ |
2 | 2 |
% Please edit documentation in R/pathway.R |
3 | 3 |
\name{pathwayEnrichment} |
4 | 4 |
\alias{pathwayEnrichment} |
5 |
-\title{For a given gmt file of a specific pathway database, pathway enrichment can be performed. Function supports Entrez ID and symbol based gmt file.} |
|
5 |
+\title{For a given gmt file of a specific pathway database, pathway enrichment can |
|
6 |
+be performed. Function supports Entrez ID and symbol based gmt file.} |
|
6 | 7 |
\usage{ |
7 |
-pathwayEnrichment(genes, gmtFile, hg, pCut = 0.05, pAdjCut = 0.05, |
|
8 |
- pAdjust = "BH", isSymbol, min = 5, isGeneEnrich = FALSE) |
|
8 |
+pathwayEnrichment(genes, gmtFile, org_assembly = c("hg19", "hg38", |
|
9 |
+ "mm10", "dre10", "rn6", "dm6", "ce11", "sc3"), pCut = 0.05, |
|
10 |
+ pAdjCut = 0.05, pAdjust = c("holm", "hochberg", "hommel", |
|
11 |
+ "bonferroni", "BH", "BY", "fdr", "none"), isSymbol, min = 5, |
|
12 |
+ isGeneEnrich = FALSE) |
|
9 | 13 |
} |
10 | 14 |
\arguments{ |
11 | 15 |
\item{genes}{Input genes} |
12 | 16 |
|
13 | 17 |
\item{gmtFile}{File path of the gmt file} |
14 | 18 |
|
15 |
-\item{hg}{Genome assembly of interest for the analysis. Possible assemblies are "mm10" for mouse, "dre10" for zebrafish, "rn6" for rat, "dm6" for fruit fly, "ce11" for worm, "sc3" for yeast, "hg19" and "hg38" for human} |
|
19 |
+\item{org_assembly}{Genome assembly of interest for the analysis. Possible |
|
20 |
+assemblies are "mm10" for mouse, "dre10" for zebrafish, "rn6" for rat, |
|
21 |
+"dm6" for fruit fly, "ce11" for worm, "sc3" for yeast, "hg19" and |
|
22 |
+"hg38" for human} |
|
16 | 23 |
|
17 | 24 |
\item{pCut}{Threshold value for the pvalue. Default value is 0.05} |
18 | 25 |
|
19 |
-\item{pAdjCut}{Cutoff value for the adjusted p-values using one of given method. Default value is 0.05.} |
|
26 |
+\item{pAdjCut}{Cutoff value for the adjusted p-values using one of given |
|
27 |
+method. Default value is 0.05.} |
|
20 | 28 |
|
21 |
-\item{pAdjust}{Methods of the adjusted p-values. Possible methods are "bonferroni", "holm", "BH"(default)} |
|
29 |
+\item{pAdjust}{Methods of the adjusted p-values. Possible methods are |
|
30 |
+"holm", "hochberg", "hommel", "bonferroni", "BH", "BY","fdr", "none"} |
|
22 | 31 |
|
23 |
-\item{isSymbol}{Boolean value that controls the gene formats. If it is TRUE, gene format of the gmt file should be symbol. Otherwise, gene format must be ENTREZ ID.} |
|
32 |
+\item{isSymbol}{Boolean value that controls the gene formats. If it is TRUE, |
|
33 |
+gene format of the gmt file should be symbol. Otherwise, gene format |
|
34 |
+must be ENTREZ ID.} |
|
24 | 35 |
|
25 |
-\item{min}{Minimum number of genes that are required for enrichment. By default, it is set to 5.} |
|
36 |
+\item{min}{Minimum number of genes that are required for enrichment. By |
|
37 |
+default, it is set to 5.} |
|
26 | 38 |
|
27 |
-\item{isGeneEnrich}{Boolean value whether gene enrichment should be performed} |
|
39 |
+\item{isGeneEnrich}{Boolean value whether gene enrichment should be |
|
40 |
+performed} |
|
28 | 41 |
} |
29 | 42 |
\value{ |
30 | 43 |
Pathway Enrichment |
31 | 44 |
} |
32 | 45 |
\description{ |
33 |
-For a given gmt file of a specific pathway database, pathway enrichment can be performed. Function supports Entrez ID and symbol based gmt file. |
|
34 |
-} |
|
35 |
-\examples{ |
|
36 |
-tmpGene <- breastmRNA[1:100,] |
|
37 |
-\dontrun{ |
|
38 |
-br_enr<-pathwayEnrichment(genes = tmpGene,hg='hg19', |
|
39 |
- gmtFile = 'Human_AllPathways_February_01_2019_symbol.gmt',isSymbol = TRUE) |
|
40 |
-} |
|
46 |
+For a given gmt file of a specific pathway database, pathway enrichment can |
|
47 |
+be performed. Function supports Entrez ID and symbol based gmt file. |
|
41 | 48 |
} |
1 | 1 |
new file mode 100644 |
... | ... |
@@ -0,0 +1,41 @@ |
1 |
+% Generated by roxygen2: do not edit by hand |
|
2 |
+% Please edit documentation in R/pathway.R |
|
3 |
+\name{pathwayEnrichment} |
|
4 |
+\alias{pathwayEnrichment} |
|
5 |
+\title{For a given gmt file of a specific pathway database, pathway enrichment can be performed. Function supports Entrez ID and symbol based gmt file.} |
|
6 |
+\usage{ |
|
7 |
+pathwayEnrichment(genes, gmtFile, hg, pCut = 0.05, pAdjCut = 0.05, |
|
8 |
+ pAdjust = "BH", isSymbol, min = 5, isGeneEnrich = FALSE) |
|
9 |
+} |
|
10 |
+\arguments{ |
|
11 |
+\item{genes}{Input genes} |
|
12 |
+ |
|
13 |
+\item{gmtFile}{File path of the gmt file} |
|
14 |
+ |
|
15 |
+\item{hg}{Genome assembly of interest for the analysis. Possible assemblies are "mm10" for mouse, "dre10" for zebrafish, "rn6" for rat, "dm6" for fruit fly, "ce11" for worm, "sc3" for yeast, "hg19" and "hg38" for human} |
|
16 |
+ |
|
17 |
+\item{pCut}{Threshold value for the pvalue. Default value is 0.05} |
|
18 |
+ |
|
19 |
+\item{pAdjCut}{Cutoff value for the adjusted p-values using one of given method. Default value is 0.05.} |
|
20 |
+ |
|
21 |
+\item{pAdjust}{Methods of the adjusted p-values. Possible methods are "bonferroni", "holm", "BH"(default)} |
|
22 |
+ |
|
23 |
+\item{isSymbol}{Boolean value that controls the gene formats. If it is TRUE, gene format of the gmt file should be symbol. Otherwise, gene format must be ENTREZ ID.} |
|
24 |
+ |
|
25 |
+\item{min}{Minimum number of genes that are required for enrichment. By default, it is set to 5.} |
|
26 |
+ |
|
27 |
+\item{isGeneEnrich}{Boolean value whether gene enrichment should be performed} |
|
28 |
+} |
|
29 |
+\value{ |
|
30 |
+Pathway Enrichment |
|
31 |
+} |
|
32 |
+\description{ |
|
33 |
+For a given gmt file of a specific pathway database, pathway enrichment can be performed. Function supports Entrez ID and symbol based gmt file. |
|
34 |
+} |
|
35 |
+\examples{ |
|
36 |
+tmpGene <- breastmRNA[1:100,] |
|
37 |
+\dontrun{ |
|
38 |
+br_enr<-pathwayEnrichment(genes = tmpGene,hg='hg19', |
|
39 |
+ gmtFile = 'Human_AllPathways_February_01_2019_symbol.gmt',isSymbol = TRUE) |
|
40 |
+} |
|
41 |
+} |