Cellenics integration
Issue being solved: https://github.com/nf-core/scrnaseq/issues/156
PR checklist
- [ ] 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 you've added a new tool - have you followed the pipeline conventions in the contribution docs- [ ] If necessary, also make a PR on the nf-core/scrnaseq branch on the nf-core/test-datasets repository.
- [ ] Make sure your code lints (
nf-core lint). - [ ] Ensure the test suite passes (
nextflow run . -profile test,docker --outdir <OUTDIR>). - [ ] Usage Documentation in
docs/usage.mdis updated. - [ ] Output Documentation in
docs/output.mdis updated. - [ ]
CHANGELOG.mdis updated. - [ ]
README.mdis updated (including new tool citations and authors/contributors).
This PR is against the master branch :x:
- Do not close this PR
- Click Edit and change the
basetodev - This CI test will remain failed until you push a new commit
Hi @kafkasl,
It looks like this pull-request is has been made against the biomage-org/scrnaseq master branch.
The master branch on nf-core repositories should always contain code from the latest release.
Because of this, PRs to master are only allowed if they come from the biomage-org/scrnaseq dev branch.
You do not need to close this PR, you can change the target branch to dev by clicking the "Edit" button at the top of this page.
Note that even after this, the test will continue to show as failing until you push a new commit.
Thanks again for your contribution!
nf-core lint overall result: Passed :white_check_mark:
Posted for pipeline commit 423b4c3
+| ✅ 158 tests passed |+
:white_check_mark: Tests passed:
-
files_exist - File found:
.gitattributes -
files_exist - File found:
.gitignore -
files_exist - File found:
.nf-core.yml -
files_exist - File found:
.editorconfig -
files_exist - File found:
.prettierignore -
files_exist - File found:
.prettierrc.yml -
files_exist - File found:
CHANGELOG.md -
files_exist - File found:
CITATIONS.md -
files_exist - File found:
CODE_OF_CONDUCT.md -
files_exist - File found:
CODE_OF_CONDUCT.md -
files_exist - File found:
LICENSEorLICENSE.mdorLICENCEorLICENCE.md -
files_exist - File found:
nextflow_schema.json -
files_exist - File found:
nextflow.config -
files_exist - File found:
README.md -
files_exist - File found:
.github/.dockstore.yml -
files_exist - File found:
.github/CONTRIBUTING.md -
files_exist - File found:
.github/ISSUE_TEMPLATE/bug_report.yml -
files_exist - File found:
.github/ISSUE_TEMPLATE/config.yml -
files_exist - File found:
.github/ISSUE_TEMPLATE/feature_request.yml -
files_exist - File found:
.github/PULL_REQUEST_TEMPLATE.md -
files_exist - File found:
.github/workflows/branch.yml -
files_exist - File found:
.github/workflows/ci.yml -
files_exist - File found:
.github/workflows/linting_comment.yml -
files_exist - File found:
.github/workflows/linting.yml -
files_exist - File found:
assets/email_template.html -
files_exist - File found:
assets/email_template.txt -
files_exist - File found:
assets/sendmail_template.txt -
files_exist - File found:
assets/nf-core-scrnaseq_logo_light.png -
files_exist - File found:
conf/modules.config -
files_exist - File found:
conf/test.config -
files_exist - File found:
conf/test_full.config -
files_exist - File found:
docs/images/nf-core-scrnaseq_logo_light.png -
files_exist - File found:
docs/images/nf-core-scrnaseq_logo_dark.png -
files_exist - File found:
docs/output.md -
files_exist - File found:
docs/README.md -
files_exist - File found:
docs/README.md -
files_exist - File found:
docs/usage.md -
files_exist - File found:
lib/nfcore_external_java_deps.jar -
files_exist - File found:
lib/NfcoreSchema.groovy -
files_exist - File found:
lib/NfcoreTemplate.groovy -
files_exist - File found:
lib/Utils.groovy -
files_exist - File found:
lib/WorkflowMain.groovy -
files_exist - File found:
main.nf -
files_exist - File found:
assets/multiqc_config.yml -
files_exist - File found:
conf/base.config -
files_exist - File found:
conf/igenomes.config -
files_exist - File found:
.github/workflows/awstest.yml -
files_exist - File found:
.github/workflows/awsfulltest.yml -
files_exist - File found:
lib/WorkflowScrnaseq.groovy -
files_exist - File found:
modules.json -
files_exist - File found:
pyproject.toml -
files_exist - File not found check:
Singularity -
files_exist - File not found check:
parameters.settings.json -
files_exist - File not found check:
.nf-core.yaml -
files_exist - File not found check:
bin/markdown_to_html.r -
files_exist - File not found check:
conf/aws.config -
files_exist - File not found check:
.github/workflows/push_dockerhub.yml -
files_exist - File not found check:
.github/ISSUE_TEMPLATE/bug_report.md -
files_exist - File not found check:
.github/ISSUE_TEMPLATE/feature_request.md -
files_exist - File not found check:
docs/images/nf-core-scrnaseq_logo.png -
files_exist - File not found check:
.markdownlint.yml -
files_exist - File not found check:
.yamllint.yml -
files_exist - File not found check:
lib/Checks.groovy -
files_exist - File not found check:
lib/Completion.groovy -
files_exist - File not found check:
lib/Workflow.groovy -
files_exist - File not found check:
.travis.yml -
nextflow_config - Config variable found:
manifest.name -
nextflow_config - Config variable found:
manifest.nextflowVersion -
nextflow_config - Config variable found:
manifest.description -
nextflow_config - Config variable found:
manifest.version -
nextflow_config - Config variable found:
manifest.homePage -
nextflow_config - Config variable found:
timeline.enabled -
nextflow_config - Config variable found:
trace.enabled -
nextflow_config - Config variable found:
report.enabled -
nextflow_config - Config variable found:
dag.enabled -
nextflow_config - Config variable found:
process.cpus -
nextflow_config - Config variable found:
process.memory -
nextflow_config - Config variable found:
process.time -
nextflow_config - Config variable found:
params.outdir -
nextflow_config - Config variable found:
params.input -
nextflow_config - Config variable found:
params.show_hidden_params -
nextflow_config - Config variable found:
params.schema_ignore_params -
nextflow_config - Config variable found:
manifest.mainScript -
nextflow_config - Config variable found:
timeline.file -
nextflow_config - Config variable found:
trace.file -
nextflow_config - Config variable found:
report.file -
nextflow_config - Config variable found:
dag.file -
nextflow_config - Config variable (correctly) not found:
params.version -
nextflow_config - Config variable (correctly) not found:
params.nf_required_version -
nextflow_config - Config variable (correctly) not found:
params.container -
nextflow_config - Config variable (correctly) not found:
params.singleEnd -
nextflow_config - Config variable (correctly) not found:
params.igenomesIgnore -
nextflow_config - Config variable (correctly) not found:
params.name -
nextflow_config - Config
timeline.enabledhad correct value:true -
nextflow_config - Config
report.enabledhad correct value:true -
nextflow_config - Config
trace.enabledhad correct value:true -
nextflow_config - Config
dag.enabledhad correct value:true -
nextflow_config - Config
manifest.namebegan withnf-core/ -
nextflow_config - Config variable
manifest.homePagebegan with https://github.com/nf-core/ -
nextflow_config - Config
dag.fileended with.html -
nextflow_config - Config variable
manifest.nextflowVersionstarted with >= or !>= -
nextflow_config - Config
manifest.versionends indev:'2.1.1dev' -
nextflow_config - Config
params.custom_config_versionis set tomaster -
nextflow_config - Config
params.custom_config_baseis set tohttps://raw.githubusercontent.com/nf-core/configs/master - nextflow_config - Lines for loading custom profiles found
-
files_unchanged -
.gitattributesmatches the template -
files_unchanged -
.prettierrc.ymlmatches the template -
files_unchanged -
CODE_OF_CONDUCT.mdmatches the template -
files_unchanged -
LICENSEmatches the template -
files_unchanged -
.github/.dockstore.ymlmatches the template -
files_unchanged -
.github/CONTRIBUTING.mdmatches the template -
files_unchanged -
.github/ISSUE_TEMPLATE/bug_report.ymlmatches the template -
files_unchanged -
.github/ISSUE_TEMPLATE/config.ymlmatches the template -
files_unchanged -
.github/ISSUE_TEMPLATE/feature_request.ymlmatches the template -
files_unchanged -
.github/PULL_REQUEST_TEMPLATE.mdmatches the template -
files_unchanged -
.github/workflows/branch.ymlmatches the template -
files_unchanged -
.github/workflows/linting_comment.ymlmatches the template -
files_unchanged -
.github/workflows/linting.ymlmatches the template -
files_unchanged -
assets/email_template.htmlmatches the template -
files_unchanged -
assets/email_template.txtmatches the template -
files_unchanged -
assets/sendmail_template.txtmatches the template -
files_unchanged -
assets/nf-core-scrnaseq_logo_light.pngmatches the template -
files_unchanged -
docs/images/nf-core-scrnaseq_logo_light.pngmatches the template -
files_unchanged -
docs/images/nf-core-scrnaseq_logo_dark.pngmatches the template -
files_unchanged -
docs/README.mdmatches the template -
files_unchanged -
lib/nfcore_external_java_deps.jarmatches the template -
files_unchanged -
lib/NfcoreSchema.groovymatches the template -
files_unchanged -
lib/NfcoreTemplate.groovymatches the template -
files_unchanged -
.gitignorematches the template -
files_unchanged -
.prettierignorematches the template -
files_unchanged -
pyproject.tomlmatches the template - actions_ci - '.github/workflows/ci.yml' is triggered on expected events
- actions_ci - '.github/workflows/ci.yml' checks minimum NF version
- actions_awstest - '.github/workflows/awstest.yml' is triggered correctly
-
actions_awsfulltest -
.github/workflows/awsfulltest.ymlis triggered correctly -
actions_awsfulltest -
.github/workflows/awsfulltest.ymldoes not use-profile test -
readme - README Nextflow minimum version badge matched config. Badge:
21.10.3, Config:21.10.3 -
readme - README Nextflow minimum version in Quick Start section matched config. README:
21.10.3, Config:21.10.3 - pipeline_todos - No TODO strings found
- pipeline_name_conventions - Name adheres to nf-core convention
- template_strings - Did not find any Jinja template strings (119 files)
- schema_lint - Schema lint passed
- schema_lint - Schema title + description lint passed
- schema_lint - Input mimetype lint passed: 'text/csv'
- schema_params - Schema matched params returned from nextflow config
- actions_schema_validation - Workflow validation passed: awsfulltest.yml
- actions_schema_validation - Workflow validation passed: ci.yml
- actions_schema_validation - Workflow validation passed: linting.yml
- actions_schema_validation - Workflow validation passed: linting_comment.yml
- actions_schema_validation - Workflow validation passed: fix-linting.yml
- actions_schema_validation - Workflow validation passed: branch.yml
- actions_schema_validation - Workflow validation passed: awstest.yml
- merge_markers - No merge markers found in pipeline files
-
modules_json - Only installed modules found in
modules.json - multiqc_config - 'assets/multiqc_config.yml' follows the ordering scheme of the minimally required plugins.
- multiqc_config - 'assets/multiqc_config.yml' contains a matching 'report_comment'.
- multiqc_config - 'assets/multiqc_config.yml' contains 'export_plots: true'.
- modules_structure - modules directory structure is correct 'modules/nf-core/TOOL/SUBTOOL'
Run details
- nf-core/tools version 2.6
- Run at
2022-11-18 08:53:40
I think that this PR requires a higher level discussion on whether and/or how commercial services should be integrated. Who maintains these parts? Which commercial products would qualify and which ones not? Don't think that this conversation converged in https://github.com/nf-core/scrnaseq/issues/156
Thank you for bringing this up @Zethson. I can understand caution with commercial services.
Cellenics is not a commercial service. It's an open source project out of Harvard Medical School. It can be, and has been, independently deployed using the open source code and open source deployment scripts hosted by Harvard here: https://github.com/hms-dbmi-cellenics
It's true that many people working on Cellenics work at BioMage (including me), and it's true that a lot of deployments of Cellenics these days are installed by BioMage for commercial customers. But the product itself is fully open source (and fully and independently functional as an open source project).
One of the important decisions of keeping this integration interoperable with independent deployments of Cellenics is allowing the user to specify the URL of Cellenics instance that they want to send the data to (the plugin is not limited to e.g. community instance hosted by BioMage).
We (BioMage) will maintain parts responsible for the integration.
I'm closing this now as this kind of functionality should now be handled via nextflow plugins, which are now mature. Having various "upload to XXX" modules at the end of the pipeline creates an unreasonable maintenance burden.