millironx/nf-core_modules
1
0
Fork 0
mirror of https://github.com/MillironX/nf-core_modules.git synced 2024-11-11 04:33:10 +00:00
Code Issues Releases Packages Activity
nf-core_modules/modules/cellranger/mkfastq
History
Edmund Miller f080015754
Prettier (#1405) 
* style: Add prettier config files

* build: Add prettier vscode extension

* ci: Replace markdownlint and yamllint with prettier

* style: Run prettier

* style: Use indent of 2 for markdown as well

https://github.com/nf-core/tools/pull/1470#issuecomment-1071028358

* style: Fix indent

* style: Let editorconfig take over tab widths

* style: yaml => yml

* ci: Run prettier once

Co-authored-by: Phil Ewels <phil.ewels@scilifelab.se>

Co-authored-by: Phil Ewels <phil.ewels@scilifelab.se>
2022-03-18 14:27:50 +01:00
..
Dockerfile Add bcl2fastq2 to cellranger dockerfile (#1115) 2022-01-25 19:58:22 +01:00
main.nf Add when: block (#1261) 2022-02-04 09:53:32 +01: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

README.md

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>