nf-core_modules/modules/cellranger/mkfastq
Alexander Peltzer b573ff053e
Bugfix for CellRanger Dockerfile (#1812)
Bugfix to enable Singularity support
2022-06-27 11:07:33 +02:00
..
Dockerfile Bugfix for CellRanger Dockerfile (#1812) 2022-06-27 11:07:33 +02:00
main.nf Update main.nf 2022-06-10 11:05:59 +02:00
meta.yml Fix formatting in yaml files, add yamllint config (#1279) 2022-02-15 11:15:27 +00:00
README.md Prettier (#1405) 2022-03-18 14:27:50 +01:00

Updating the docker container and making a new module release

Bcl2fastq2 and Cell Ranger are commercial tools from Illumina and 10X Genomics, respectively. The container provided for the cellranger nf-core module is not provided nor supported by either Illumina or 10x Genomics. Updating the bcl2fastq2 or Cell Ranger versions in the container and pushing the update to Dockerhub needs to be done manually.

  1. Navigate to the appropriate download pages. - bcl2fastq2: download the linux rpm installer of the desired bcl2fastq2 version with curl or wget. Place this file in the same folder where the Dockerfile lies. - Cell Ranger: 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 bcl2fastq2 and Cell Ranger versions in this line:

    ENV BCL2FASTQ2_VER=<VERSION> \
        CELLRANGER_VER=<VERSION>
    
  3. Create and test the container:

    docker build . -t nfcore/cellrangermkfastq:<CELLRANGER_VERSION>
    
  4. Access rights are needed to push the container to the Dockerhub nfcore organization, please ask a core team member to do so.

    docker push nfcore/cellrangermkfastq:<CELLRANGER_VERSION>