Skip to content

Commit eaaf675

Browse files
authored
Merge pull request #621 from satijalab/fix/sct2vig
Update sct2 vignette installation instructions
2 parents 25f66e8 + b098fb4 commit eaaf675

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

vignettes/sctransform_v2_vignette.Rmd

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -35,12 +35,12 @@ knitr::opts_chunk$set(
3535

3636
We recently introduced [sctransform](https://genomebiology.biomedcentral.com/articles/10.1186/s13059-019-1874-1) to perform normalization and variance stabilization of scRNA-seq datasets. We now release an updated version ('v2'), based on [our broad analysis](https://www.biorxiv.org/content/10.1101/2021.07.07.451498v1) of 59 scRNA-seq datasets spanning a range of technologies, systems, and sequencing depths. This update improves speed and memory consumption, the stability of parameter estimates, the identification of variable features, and the the ability to perform downstream differential expression analyses.
3737

38-
Users can install sctransform v2 from Github (CRAN update coming soon), and invoke the use of the updated method via the `vst.flavor` argument.
38+
Users can install sctransform v2 from CRAN (sctransform v0.3.3) and invoke the use of the updated method via the `vst.flavor` argument.
3939

4040
```{r tldr, eval=FALSE}
41-
# install Seurat from Github (automatically updates sctransform)
42-
devtools::install_github("satijalab/seurat", ref="develop")
43-
# invoke sctransform
41+
# install sctransform >= 0.3.3
42+
install.packages("sctransform")
43+
# invoke sctransform - requires Seurat>=4.1
4444
object <- SCTransform(object, vst.flavor = "v2")
4545
```
4646

@@ -56,14 +56,14 @@ In this vignette, we use [sctransform v2](https://github.com/satijalab/sctransfo
5656

5757
## Install sctransform
5858

59-
We will install sctransform v2 from Github. We will also install the [glmGamPoi](https://bioconductor.org/packages/release/bioc/html/glmGamPoi.html) package which substantially improves the speed of the learning procedure.
59+
We will install sctransform v2 from CRAN (v0.3.3). We will also install the [glmGamPoi](https://bioconductor.org/packages/release/bioc/html/glmGamPoi.html) package which substantially improves the speed of the learning procedure.
6060

6161
```{r results='hide', message=FALSE, warning=FALSE}
6262
# install glmGamPoi
6363
if (!requireNamespace("BiocManager", quietly = TRUE)) install.packages("BiocManager")
6464
BiocManager::install("glmGamPoi")
6565
# install sctransform from Github
66-
devtools::install_github("satijalab/sctransform", ref="develop")
66+
install.packages("sctransform")
6767
```
6868

6969
## Setup the Seurat objects

0 commit comments

Comments
 (0)