Browse code

fix biocparallel bug

Zach Shao authored on 09/10/2018 20:27:56
Showing 1 changed files
... ...
@@ -29,7 +29,7 @@ A list is returned containing:
29 29
 }
30 30
 \description{
31 31
 \code{ggplot2_intersectPlot} function generates and plots the list of
32
-differentially expressed (DE) genes that are commonly found in all
32
+differentially expressed (DE) genes that are found in all
33 33
 combinations at any particular replicate level. Often in small-scale
34 34
 RNA-seq experiments, the inclusion or exclusion of any paricular sample can
35 35
 result in a very different list of DE genes. To reduce the influence of any
... ...
@@ -47,7 +47,7 @@ been found.
47 47
 }
48 48
 \examples{
49 49
 # load edgeR deg object generated by erssa_edger using example dataset
50
-# example dataset containing 1000 genes, 4 replicates and 10 comb. per rep.
50
+# example dataset containing 1000 genes, 4 replicates and 5 comb. per rep.
51 51
 # level
52 52
 data(deg.partial, package = "ERSSA")
53 53
 
Browse code

code optimization

Zach Shao authored on 30/08/2018 05:42:20
Showing 1 changed files
... ...
@@ -4,13 +4,15 @@
4 4
 \alias{ggplot2_intersectPlot}
5 5
 \title{Plot number of DE genes that is common across combinations}
6 6
 \usage{
7
-ggplot2_intersectPlot(deg = NULL, path = ".")
7
+ggplot2_intersectPlot(deg = NULL, path = ".", save_plot = TRUE)
8 8
 }
9 9
 \arguments{
10 10
 \item{deg}{The list of DE genes generated by one of ERSSA::DE_*.R scripts.}
11 11
 
12 12
 \item{path}{Path to which the plot will be saved. Default to current working
13 13
 directory.}
14
+
15
+\item{save_plot}{Boolean. Whether to save plot to drive. Default to TRUE.}
14 16
 }
15 17
 \value{
16 18
 A list is returned containing:
... ...
@@ -18,7 +20,8 @@ A list is returned containing:
18 20
   \item{gg_object} {the ggplot2 object, which can then be further
19 21
   customized.}
20 22
   \item{intersect.dataframe} {the tidy table version used for plotting.}
21
-  \item{deg_dataframe} {the tidy table version of DEG numbers for plotting mean.}
23
+  \item{deg_dataframe} {the tidy table version of DEG numbers for
24
+  plotting mean.}
22 25
   \item{intersect_genes} {list of vectors containing DE genes with vector
23 26
   name indicating the associated replicate level.}
24 27
   \item{full_num_DEG} {The number of DE genes with all samples included.}
... ...
@@ -29,7 +32,7 @@ A list is returned containing:
29 32
 differentially expressed (DE) genes that are commonly found in all
30 33
 combinations at any particular replicate level. Often in small-scale
31 34
 RNA-seq experiments, the inclusion or exclusion of any paricular sample can
32
-result in a highly different list of DE genes. To reduce the influence of any
35
+result in a very different list of DE genes. To reduce the influence of any
33 36
 particular sample in the entire dataset analysis, it may be desirable to
34 37
 identify the list of DE genes that are enriched regardless of any specific
35 38
 sample(s) inclusion. This approach may be most useful analyzing the list of
... ...
@@ -41,16 +44,6 @@ Similar to how increasing number of detected DE genes can be found with more
41 44
 biological replicates, the list of common DE genes is expected to increase
42 45
 with more replicates. This eventually levels off as majority of DE genes have
43 46
 been found.
44
-
45
-Another similar analytical approach is to repeat DE analysis with all
46
-combinations of samples with one sample left out. In typical datasets with
47
-equal number of samples in both conditions, this approach will include one
48
-additional sample in the comparison, potentially leading to improvement in
49
-detection. However, the number of possible combinations with this approach
50
-will be less than the ones possible with ERSSA. As a result, the identified
51
-common gene list may not be as robust as the one identified with ERSSA.
52
-Regardless, in practice, both approaches are likely to generate comparable
53
-DE gene lists.
54 47
 }
55 48
 \examples{
56 49
 # load edgeR deg object generated by erssa_edger using example dataset
Browse code

update vignette, plot improvements

Former-commit-id: b10c8d25c2b974168c3bc853c86279d7b3d93300

Zach Shao authored on 19/07/2018 16:55:53
Showing 1 changed files
... ...
@@ -18,6 +18,7 @@ A list is returned containing:
18 18
   \item{gg_object} {the ggplot2 object, which can then be further
19 19
   customized.}
20 20
   \item{intersect.dataframe} {the tidy table version used for plotting.}
21
+  \item{deg_dataframe} {the tidy table version of DEG numbers for plotting mean.}
21 22
   \item{intersect_genes} {list of vectors containing DE genes with vector
22 23
   name indicating the associated replicate level.}
23 24
   \item{full_num_DEG} {The number of DE genes with all samples included.}
Browse code

add citation and reduce example runtime

Former-commit-id: cecec5ad83061d3075992c4610080ef9b93fc418

Zach Shao authored on 05/06/2018 22:15:48
Showing 1 changed files
... ...
@@ -52,12 +52,17 @@ Regardless, in practice, both approaches are likely to generate comparable
52 52
 DE gene lists.
53 53
 }
54 54
 \examples{
55
-#load edgeR deg object generated by erssa_edger using example dataset
56
-#test dataset with 1000 genes, 4 replicates and 20 comb. per rep. level
55
+# load edgeR deg object generated by erssa_edger using example dataset
56
+# example dataset containing 1000 genes, 4 replicates and 10 comb. per rep.
57
+# level
57 58
 data(deg.partial, package = "ERSSA")
58 59
 
59 60
 gg_intersect = ggplot2_intersectPlot(deg.partial)
60 61
 
62
+}
63
+\references{
64
+H. Wickham. ggplot2: Elegant Graphics for Data Analysis.
65
+Springer-Verlag New York, 2009.
61 66
 }
62 67
 \author{
63 68
 Zixuan Shao, \email{[email protected]}
Browse code

update manual and use better example to save testing time

Former-commit-id: 6608ba93deb81c2fc26a1597505512c09d0e8c64

Zach Shao authored on 07/05/2018 21:55:56
Showing 1 changed files
... ...
@@ -53,7 +53,7 @@ DE gene lists.
53 53
 }
54 54
 \examples{
55 55
 #load edgeR deg object generated by erssa_edger using example dataset
56
-#only 5000 genes and 4 replicates tested to speed up runtime
56
+#test dataset with 1000 genes, 4 replicates and 20 comb. per rep. level
57 57
 data(deg.partial, package = "ERSSA")
58 58
 
59 59
 gg_intersect = ggplot2_intersectPlot(deg.partial)
Browse code

new plots, updated manual, vignette skeleton and news

Former-commit-id: 24bcc08ceecbd7a204bafc18c016b00b90e68c3b

Zach Shao authored on 11/04/2018 17:09:06
Showing 1 changed files
1 1
new file mode 100644
... ...
@@ -0,0 +1,64 @@
1
+% Generated by roxygen2: do not edit by hand
2
+% Please edit documentation in R/plot_intersectPlot.R
3
+\name{ggplot2_intersectPlot}
4
+\alias{ggplot2_intersectPlot}
5
+\title{Plot number of DE genes that is common across combinations}
6
+\usage{
7
+ggplot2_intersectPlot(deg = NULL, path = ".")
8
+}
9
+\arguments{
10
+\item{deg}{The list of DE genes generated by one of ERSSA::DE_*.R scripts.}
11
+
12
+\item{path}{Path to which the plot will be saved. Default to current working
13
+directory.}
14
+}
15
+\value{
16
+A list is returned containing:
17
+ \itemize{
18
+  \item{gg_object} {the ggplot2 object, which can then be further
19
+  customized.}
20
+  \item{intersect.dataframe} {the tidy table version used for plotting.}
21
+  \item{intersect_genes} {list of vectors containing DE genes with vector
22
+  name indicating the associated replicate level.}
23
+  \item{full_num_DEG} {The number of DE genes with all samples included.}
24
+}
25
+}
26
+\description{
27
+\code{ggplot2_intersectPlot} function generates and plots the list of
28
+differentially expressed (DE) genes that are commonly found in all
29
+combinations at any particular replicate level. Often in small-scale
30
+RNA-seq experiments, the inclusion or exclusion of any paricular sample can
31
+result in a highly different list of DE genes. To reduce the influence of any
32
+particular sample in the entire dataset analysis, it may be desirable to
33
+identify the list of DE genes that are enriched regardless of any specific
34
+sample(s) inclusion. This approach may be most useful analyzing the list of
35
+common DE genes at the greatest possible replicate to take advantage of the
36
+robust feature as well as employing typically the longest list of DE genes.
37
+}
38
+\details{
39
+Similar to how increasing number of detected DE genes can be found with more
40
+biological replicates, the list of common DE genes is expected to increase
41
+with more replicates. This eventually levels off as majority of DE genes have
42
+been found.
43
+
44
+Another similar analytical approach is to repeat DE analysis with all
45
+combinations of samples with one sample left out. In typical datasets with
46
+equal number of samples in both conditions, this approach will include one
47
+additional sample in the comparison, potentially leading to improvement in
48
+detection. However, the number of possible combinations with this approach
49
+will be less than the ones possible with ERSSA. As a result, the identified
50
+common gene list may not be as robust as the one identified with ERSSA.
51
+Regardless, in practice, both approaches are likely to generate comparable
52
+DE gene lists.
53
+}
54
+\examples{
55
+#load edgeR deg object generated by erssa_edger using example dataset
56
+#only 5000 genes and 4 replicates tested to speed up runtime
57
+data(deg.partial, package = "ERSSA")
58
+
59
+gg_intersect = ggplot2_intersectPlot(deg.partial)
60
+
61
+}
62
+\author{
63
+Zixuan Shao, \email{[email protected]}
64
+}