Skip to content

Commit 36be8a0

Browse files
committed
update vignette
1 parent d00cc61 commit 36be8a0

File tree

1 file changed

+9
-19
lines changed

1 file changed

+9
-19
lines changed

vignettes/barbieQ.Rmd

Lines changed: 9 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -49,14 +49,14 @@ The main functions include:
4949
# Intallation
5050

5151
```{r install, eval=FALSE}
52-
# You can install the development version of barbieQ like so:
53-
# if (!require("BiocManager", quietly = TRUE))
54-
# install.packages("BiocManager")
55-
#
56-
# BiocManager::install("barbieQ")
52+
# You can install the stable version of barbieQ like so:
53+
if (!require("BiocManager", quietly = TRUE))
54+
install.packages("BiocManager")
55+
56+
BiocManager::install("barbieQ")
5757
5858
## Alternatively, you can install the development version of barbieQ from GitHub
59-
devtools::install_github("Oshlack/barbieQ")
59+
# devtools::install_github("Oshlack/barbieQ")
6060
```
6161

6262
# Load Dependecy
@@ -189,34 +189,24 @@ Based on the understanding of sample conditions that likely to be the source of
189189

190190
- By specifying the parameter `method` by `diffProp` (defaulted), you are testing individual barcodes' **differential proportion** between conditions.
191191

192+
- By specifying the parameter `method` by `diffOcc`, you are testing individual barcodes' **differential occurrence** between conditions.
193+
192194
```{r test diffProp, fig.width=6, fig.height=5}
193195
## test Barcode differential proportion between sample groups
194196
exampleBBQ <- testBarcodeSignif(
195197
barbieQ = exampleBBQ,
196198
contrastFormula = "(CelltypeNK_CD56n_CD16p) - (CelltypeB+CelltypeGr+CelltypeT+CelltypeNK_CD56p_CD16n)/4",
197199
method = "diffProp"
198200
)
199-
plotSignifBarcodeHeatmap(exampleBBQ) |> plot()
200-
plotSignifBarcodeProportion(exampleBBQ) |> plot()
201-
plotBarcodeMA(exampleBBQ) |> plot()
202201
```
203202

204-
- By specifying the parameter `method` by `diffOcc`, you are testing individual barcodes' **differential occurrence** between conditions.
205203

206-
```{r test diffOcc, fig.width=5, fig.height=4}
207-
## test Barcode differential occurrence between sample groups
208-
exampleBBQ <- testBarcodeSignif(
209-
barbieQ = exampleBBQ,
210-
sampleGroup = "Treat",
211-
method = "diffOcc"
212-
)
204+
```{r vis MA plot, fig.width=8, fig.height=4}
213205
plotBarcodeMA(exampleBBQ) |> plot()
214-
215206
```
216207

217208
```{r vis testing HP, fig.width=14, fig.height=6}
218209
plotSignifBarcodeHeatmap(exampleBBQ) |> plot()
219-
220210
```
221211

222212
```{r vis testing prop, fig.width=8, fig.height=5}

0 commit comments

Comments
 (0)