Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add dockerfile for bcl2fastq and cellranger #5

Merged
merged 3 commits into from
Mar 6, 2020

Conversation

thanhleviet
Copy link
Contributor

Many thanks to contributing to nf-core/demultiplex!

Please fill in the appropriate checklist below (delete whatever is not relevant). These are the most common things requested on pull requests (PRs).

PR checklist

  • [x ] This comment contains a description of changes (with reason)
  • If you've fixed a bug or added code that should be tested, add tests!
  • If necessary, also make a PR on the nf-core/demultiplex branch on the nf-core/test-datasets repo
  • Ensure the test suite passes (nextflow run . -profile test,docker).
  • Make sure your code lints (nf-core lint .).
  • Documentation in docs is updated
  • CHANGELOG.md is updated
  • README.md is updated

Learn more about contributing: https://github.com/nf-core/demultiplex/tree/master/.github/CONTRIBUTING.md

Copy link
Contributor

@csawye01 csawye01 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great thannks!

@@ -0,0 +1 @@
FROM dceoy/bcl2fastq
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @thanhleviet 👍 Maybe we can just copy the instructions here instead so I can tag the container based on the version of bcl2fastq?
https://hub.docker.com/r/dceoy/bcl2fastq/dockerfile

The container is tagged to latest there so it could change.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did you mean copying the Dockerfile instruction? If so, no, because the download link to bcl2fastq has been closed.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok. So lets just download and use that image then. No point adding a Docker image for that on nf-core. Are there any other containers on Dockerhub that are tagged with the version of bcf2fastq? Its better to be explicit about this in the pipeline if possible.

@@ -0,0 +1,129 @@
#Modified from http://github.com/TomKellyGenetics/cellranger_clean
FROM ubuntu:18.04
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Have you tested this container locally?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, docker built it successfully but the image size is 6.2GB

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool 👍

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please note that this is a work-in-progress. The container builds but calling cellranger is still being tested. I have it working locally but the remote versions are still being updated. Specifically:

  • dependencies on a new version of jinja2 are required for SUMMARZE.REPORTS
  • an updated version of tsne is required to run TSNE
  • the scripts to create a cloupe file are closed source, as a workaround I have replaced it with a bash script that checks compatible inputs and returns a text file

The proprietary scripts from 10x Genomics are required to generate a working Cloupe file, they are not supported by this container. Please see the updated repo for details: https://github.com/TomKellyGenetics/cellranger_clean

@drpatelh drpatelh merged commit 4d9e7de into nf-core:dev Mar 6, 2020
Copy link
Member

@TomKellyGenetics TomKellyGenetics left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm okay with this container being used but please bear in mind that it is not supported by 10x Genomics (I have no affiliation with them). It is experimental for testing cellranger version 3. I don't have plans to maintain or support updated versions of cellranger it at this stage.

Cloupe files will not be supported by this version. Please note that they are subject to the 10x Genomics End User License Agreement.

@@ -0,0 +1,129 @@
#Modified from http://github.com/TomKellyGenetics/cellranger_clean
FROM ubuntu:18.04
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please note that this is a work-in-progress. The container builds but calling cellranger is still being tested. I have it working locally but the remote versions are still being updated. Specifically:

  • dependencies on a new version of jinja2 are required for SUMMARZE.REPORTS
  • an updated version of tsne is required to run TSNE
  • the scripts to create a cloupe file are closed source, as a workaround I have replaced it with a bash script that checks compatible inputs and returns a text file

The proprietary scripts from 10x Genomics are required to generate a working Cloupe file, they are not supported by this container. Please see the updated repo for details: https://github.com/TomKellyGenetics/cellranger_clean

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants