nf-core_modules/modules/cellranger/readme.md
Gisela Gabernet d5183a7fec
new module cellranger mkref (#896)
* add cellranger mkref module

* add cellranger mkref tests

* update test yml chksum

* fix module linting

* fix test yml

* fix getprocessname

* fix versions typo

* fix cellranger test.yml

* fix versions.yml

* test versions.yml

* fix grep version

* fix cellranger version

* add dockerfile and readme

* review container statement

* Update modules/cellranger/mkref/meta.yml

Co-authored-by: Gregor Sturm <mail@gregor-sturm.de>

* add disclaimers

* change location dockerfile

Co-authored-by: Gregor Sturm <mail@gregor-sturm.de>
2021-10-28 13:33:57 +02:00

18 lines
878 B
Markdown

# Updating the docker container and making a new module release
Cell Ranger is a commercial tool by 10X Genomics. The container provided for the cellranger nf-core module is not provided nor supported by 10x Genomics. Updating the Cell Ranger version in the container and pushing the update to Dockerhub needs to be done manually.
1. Navigate to the [Cell Ranger download page](https://support.10xgenomics.com/single-cell-gene-expression/software/downloads/latest) and download the tar ball of the desired Cell Ranger version with `curl` or `wget`. Place this file in the same folder where the Dockerfile lies.
2. Edit the Dockerfile: update the Cell Ranger version in this line:
```bash
ENV CELLRANGER_VER <VERSION>
```
3. Create the container:
```bash
docker build . -t nfcore/cellranger:<VERSION>
docker push nfcore/cellranger:<VERSION>
```