Skip to content

Commit ddbd469

Browse files
authored
Merge pull request #207 from grst/update-readme
update readme
2 parents f189432 + e0726b8 commit ddbd469

File tree

2 files changed

+5
-4
lines changed

2 files changed

+5
-4
lines changed

README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@
44
[![GitHub Actions Linting Status](https://github.com/nf-core/scrnaseq/workflows/nf-core%20linting/badge.svg)](https://github.com/nf-core/scrnaseq/actions?query=workflow%3A%22nf-core+linting%22)
55
[![AWS CI](https://img.shields.io/badge/CI%20tests-full%20size-FF9900?logo=Amazon%20AWS)](https://nf-co.re/scrnaseq/results)
66
[![Cite with Zenodo](http://img.shields.io/badge/DOI-10.5281/zenodo.3568187-1073c8)](https://doi.org/10.5281/zenodo.3568187)
7-
[![Cite with Zenodo](http://img.shields.io/badge/DOI-10.5281/zenodo.6656322)](https://doi.org/10.5281/zenodo.6656322)
8-
97
[![Nextflow](https://img.shields.io/badge/nextflow%20DSL2-%E2%89%A522.10.1-23aa62.svg)](https://www.nextflow.io/)
108
[![run with conda](http://img.shields.io/badge/run%20with-conda-3EB049?labelColor=000000&logo=anaconda)](https://docs.conda.io/en/latest/)
119
[![run with docker](https://img.shields.io/badge/run%20with-docker-0db7ed?labelColor=000000&logo=docker)](https://www.docker.com/)
@@ -28,6 +26,7 @@ This is a community effort in building a pipeline capable to support:
2826
- STARSolo
2927
- Kallisto + BUStools
3028
- Cellranger
29+
- UniverSC
3130

3231
## Documentation
3332

docs/usage.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,12 +50,14 @@ An [example samplesheet](../assets/samplesheet.csv) has been provided with the p
5050

5151
### Expected cells
5252

53-
This parameter may be used for three of the four supported aligning options.
53+
This parameter is currently supported by
5454

5555
- [Salmon Alevin](https://salmon.readthedocs.io/en/latest/alevin.html#expectcells)
56-
- [Cellranger](https://software.10xgenomics.com/single-cell-gene-expression/software/pipelines/latest/release-notes) - NB: Current recommendation is to use auto-estimation of expected cells
5756
- [STARsolo](https://github.com/alexdobin/STAR/blob/master/docs/STARsolo.md)
5857

58+
In the future, support for this paramter will be added to cellranger and UniverSC. Note that since cellranger v7,
59+
it is not recommended anymore to supply the `--expected-cells` parameter.
60+
5961
## Aligning options
6062

6163
By default, the pipeline uses [Salmon Alevin](https://salmon.readthedocs.io/en/latest/alevin.html) (i.e. --aligner alevin) to perform pseudo-alignment of reads to the reference genome and to perform the downstream BAM-level quantification. Then QC reports are generated with AlevinQC.

0 commit comments

Comments
 (0)