... | ... |
@@ -46,8 +46,8 @@ A function to visualise the features distribtuion for |
46 | 46 |
a list of SingleCellExperiment |
47 | 47 |
} |
48 | 48 |
\examples{ |
49 |
-data(sce_control_subset) |
|
50 |
-data(sce_ctcl_subset) |
|
49 |
+data(sce_control_subset, package = "CiteFuse") |
|
50 |
+data(sce_ctcl_subset, package = "CiteFuse") |
|
51 | 51 |
visualiseExprsList(sce_list = list(control = sce_control_subset, |
52 | 52 |
ctcl = sce_ctcl_subset), |
53 | 53 |
plot = "boxplot", |
... | ... |
@@ -46,8 +46,8 @@ A function to visualise the features distribtuion for |
46 | 46 |
a list of SingleCellExperiment |
47 | 47 |
} |
48 | 48 |
\examples{ |
49 |
-data("sce_control_subset", package = "CiteFuse") |
|
50 |
-data("sce_ctcl_subset", package = "CiteFuse") |
|
49 |
+data(sce_control_subset) |
|
50 |
+data(sce_ctcl_subset) |
|
51 | 51 |
visualiseExprsList(sce_list = list(control = sce_control_subset, |
52 | 52 |
ctcl = sce_ctcl_subset), |
53 | 53 |
plot = "boxplot", |
1 | 1 |
new file mode 100644 |
... | ... |
@@ -0,0 +1,60 @@ |
1 |
+% Generated by roxygen2: do not edit by hand |
|
2 |
+% Please edit documentation in R/visualise_features.R |
|
3 |
+\name{visualiseExprsList} |
|
4 |
+\alias{visualiseExprsList} |
|
5 |
+\title{visualiseExprsList} |
|
6 |
+\usage{ |
|
7 |
+visualiseExprsList( |
|
8 |
+ sce_list, |
|
9 |
+ plot = c("boxplot", "violin", "jitter", "density"), |
|
10 |
+ altExp_name = "none", |
|
11 |
+ exprs_value = "logcounts", |
|
12 |
+ group_by = NULL, |
|
13 |
+ feature_subset = NULL, |
|
14 |
+ cell_subset = NULL, |
|
15 |
+ n = NULL |
|
16 |
+) |
|
17 |
+} |
|
18 |
+\arguments{ |
|
19 |
+\item{sce_list}{A list of SingleCellExperiment object} |
|
20 |
+ |
|
21 |
+\item{plot}{Type of plot, includes boxplot, violin, jitter, density, |
|
22 |
+and pairwise. By default is boxplot} |
|
23 |
+ |
|
24 |
+\item{altExp_name}{A character indicates which expression matrix is used. |
|
25 |
+by default is none (i.e. RNA).} |
|
26 |
+ |
|
27 |
+\item{exprs_value}{A character indicates which expression value |
|
28 |
+in assayNames is used.} |
|
29 |
+ |
|
30 |
+\item{group_by}{A character indicates how is the expression |
|
31 |
+will be group in the plots (stored in colData).} |
|
32 |
+ |
|
33 |
+\item{feature_subset}{A vector of characters indicates |
|
34 |
+the subset of features that are used for visualisation} |
|
35 |
+ |
|
36 |
+\item{cell_subset}{A vector of characters indicates |
|
37 |
+the subset of cells that are used for visualisation} |
|
38 |
+ |
|
39 |
+\item{n}{A numeric indicates the top expressed features to show.} |
|
40 |
+} |
|
41 |
+\value{ |
|
42 |
+A ggplot to visualise te features distribution |
|
43 |
+} |
|
44 |
+\description{ |
|
45 |
+A function to visualise the features distribtuion for |
|
46 |
+a list of SingleCellExperiment |
|
47 |
+} |
|
48 |
+\examples{ |
|
49 |
+data("sce_control_subset", package = "CiteFuse") |
|
50 |
+data("sce_ctcl_subset", package = "CiteFuse") |
|
51 |
+visualiseExprsList(sce_list = list(control = sce_control_subset, |
|
52 |
+ctcl = sce_ctcl_subset), |
|
53 |
+plot = "boxplot", |
|
54 |
+altExp_name = "none", |
|
55 |
+exprs_value = "logcounts", |
|
56 |
+feature_subset = c("hg19_CD8A"), |
|
57 |
+group_by = c("SNF_W_louvain", "SNF_W_louvain")) |
|
58 |
+ |
|
59 |
+ |
|
60 |
+} |