... | ... |
@@ -22,7 +22,7 @@ A plot visualising the HTO expression |
22 | 22 |
A function to plot HTO expression |
23 | 23 |
} |
24 | 24 |
\examples{ |
25 |
-data(CITEseq_example) |
|
25 |
+data(CITEseq_example, package = "CiteFuse") |
|
26 | 26 |
sce_citeseq <- preprocessing(CITEseq_example) |
27 | 27 |
sce_citeseq <- normaliseExprs(sce = sce_citeseq, |
28 | 28 |
altExp_name = "HTO", |
... | ... |
@@ -22,7 +22,7 @@ A plot visualising the HTO expression |
22 | 22 |
A function to plot HTO expression |
23 | 23 |
} |
24 | 24 |
\examples{ |
25 |
-data("CITEseq_example", package = "CiteFuse") |
|
25 |
+data(CITEseq_example) |
|
26 | 26 |
sce_citeseq <- preprocessing(CITEseq_example) |
27 | 27 |
sce_citeseq <- normaliseExprs(sce = sce_citeseq, |
28 | 28 |
altExp_name = "HTO", |
... | ... |
@@ -21,3 +21,12 @@ A plot visualising the HTO expression |
21 | 21 |
\description{ |
22 | 22 |
A function to plot HTO expression |
23 | 23 |
} |
24 |
+\examples{ |
|
25 |
+data("CITEseq_example", package = "CiteFuse") |
|
26 |
+sce_citeseq <- preprocessing(CITEseq_example) |
|
27 |
+sce_citeseq <- normaliseExprs(sce = sce_citeseq, |
|
28 |
+altExp_name = "HTO", |
|
29 |
+transform = "log") |
|
30 |
+plotHTO(sce_citeseq, 1:4) |
|
31 |
+ |
|
32 |
+} |
... | ... |
@@ -2,9 +2,9 @@ |
2 | 2 |
% Please edit documentation in R/QCfunctions.R |
3 | 3 |
\name{plotHTO} |
4 | 4 |
\alias{plotHTO} |
5 |
-\title{A function to plot HTO expression} |
|
5 |
+\title{plotHTO} |
|
6 | 6 |
\usage{ |
7 |
-plotHTO(sce, which_idx = 1:2, altExp_name = NULL, ncol = 2) |
|
7 |
+plotHTO(sce, which_idx = seq_len(2), altExp_name = NULL, ncol = 2) |
|
8 | 8 |
} |
9 | 9 |
\arguments{ |
10 | 10 |
\item{sce}{sce} |
... | ... |
@@ -15,6 +15,9 @@ plotHTO(sce, which_idx = 1:2, altExp_name = NULL, ncol = 2) |
15 | 15 |
|
16 | 16 |
\item{ncol}{ncol} |
17 | 17 |
} |
18 |
+\value{ |
|
19 |
+A plot visualising the HTO expression |
|
20 |
+} |
|
18 | 21 |
\description{ |
19 | 22 |
A function to plot HTO expression |
20 | 23 |
} |
1 | 1 |
new file mode 100644 |
... | ... |
@@ -0,0 +1,20 @@ |
1 |
+% Generated by roxygen2: do not edit by hand |
|
2 |
+% Please edit documentation in R/QCfunctions.R |
|
3 |
+\name{plotHTO} |
|
4 |
+\alias{plotHTO} |
|
5 |
+\title{A function to plot HTO expression} |
|
6 |
+\usage{ |
|
7 |
+plotHTO(sce, which_idx = 1:2, altExp_name = NULL, ncol = 2) |
|
8 |
+} |
|
9 |
+\arguments{ |
|
10 |
+\item{sce}{sce} |
|
11 |
+ |
|
12 |
+\item{which_idx}{which_idx} |
|
13 |
+ |
|
14 |
+\item{altExp_name}{altExp_name} |
|
15 |
+ |
|
16 |
+\item{ncol}{ncol} |
|
17 |
+} |
|
18 |
+\description{ |
|
19 |
+A function to plot HTO expression |
|
20 |
+} |