nf-core/isoseq version 2 #32

sguizard · 2024-08-29T06:43:45Z

v2.0.0 - Sapphire Duck

New entrypoint option to skip isoseq pre-processing.
Update the pipeline to nf-core 2.14.1.
Update modules.
Close #25
Close #27
Close #10

`Added`

A new entreypoint system has been implemented to allow the user where to start the analysis.
The isoseq entrypoint runs the full pipeline.
The map entrypoint runs the pipeline from the mapping step.
This new entreypoint option make possible to use the isoseq pipeline for analysis PacBio data when subreads are not provided, or for users who want to benefit from the mapping + TAMA analysis for their Nanopore data.

`Fixed`

Update modules to their nf-test version (bamtools/convert, custom/dumpsoftwareversions, gnu/sort, gstama/collapse/ gstama/merge, gstama/polyacleanup, gunzip, isoseq/refine, lima, minimap2/align, pbccs,ultra/align, ultra/index)
Since isoseq3 switch to version 4, it has been rename isoseq

Tool Previous version New version

bamtools/convert 2.5.2 2.5.2

isoseq 3.8.2 4.0.0

lima 2.7.1 2.9.0

minimap2/align 2.24 2.28

gnu/sort 8.25 9.3

multiqc 1.21 1.24.1

PR checklist

…nto template_update_2.14.1

require a meta map in newer version

give the user the possibility to start from the mapping step and do not run isoseq pre-analysis.

github-actions · 2024-08-29T10:07:27Z

`nf-core lint` overall result: Passed ✅ ⚠️

Posted for pipeline commit 6551adf

+| ✅ 198 tests passed       |+
#| ❔   1 tests were ignored |#
!| ❗   6 tests had warnings |!

❗ Test warnings:

nextflow_config - Config manifest.version should end in dev: 2.0.0
pipeline_todos - TODO string in awsfulltest.yml: You can customise AWS full pipeline tests as required
pipeline_todos - TODO string in methods_description_template.yml: #Update the HTML below to your preferred methods description, e.g. add publication citation for this pipeline
pipeline_todos - TODO string in main.nf: Optionally add in-text citation tools to this list.
pipeline_todos - TODO string in main.nf: Optionally add bibliographic entries to this list.
pipeline_todos - TODO string in main.nf: Only uncomment below if logic in toolCitationText/toolBibliographyText has been filled!

❔ Tests ignored:

files_unchanged - File ignored due to lint config: .github/workflows/linting.yml

✅ 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: LICENSE or LICENSE.md or LICENCE or LICENCE.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-isoseq_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-isoseq_logo_light.png
files_exist - File found: docs/images/nf-core-isoseq_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: 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: modules.json
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: .github/workflows/push_dockerhub.yml
files_exist - File not found check: .markdownlint.yml
files_exist - File not found check: .nf-core.yaml
files_exist - File not found check: .yamllint.yml
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: docs/images/nf-core-isoseq_logo.png
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/NfcoreTemplate.groovy
files_exist - File not found check: lib/Utils.groovy
files_exist - File not found check: lib/Workflow.groovy
files_exist - File not found check: lib/WorkflowMain.groovy
files_exist - File not found check: lib/WorkflowIsoseq.groovy
files_exist - File not found check: parameters.settings.json
files_exist - File not found check: pipeline_template.yml
files_exist - File not found check: Singularity
files_exist - File not found check: lib/nfcore_external_java_deps.jar
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.validationShowHiddenParams
nextflow_config - Config variable found: params.validationSchemaIgnoreParams
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.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 variable (correctly) not found: params.enable_conda
nextflow_config - Config timeline.enabled had correct value: true
nextflow_config - Config report.enabled had correct value: true
nextflow_config - Config trace.enabled had correct value: true
nextflow_config - Config dag.enabled had correct value: true
nextflow_config - Config manifest.name began with nf-core/
nextflow_config - Config variable manifest.homePage began with https://github.com/nf-core/
nextflow_config - Config dag.file ended with .html
nextflow_config - Config variable manifest.nextflowVersion started with >= or !>=
nextflow_config - Config params.custom_config_version is set to master
nextflow_config - Config params.custom_config_base is set to https://raw.githubusercontent.com/nf-core/configs/master
nextflow_config - Lines for loading custom profiles found
nextflow_config - nextflow.config contains configuration profile test
nextflow_config - Config default value correct: params.entrypoint= isoseq
nextflow_config - Config default value correct: params.chunk= 40
nextflow_config - Config default value correct: params.rq= 0.9
nextflow_config - Config default value correct: params.min_passes= 3
nextflow_config - Config default value correct: params.min_snr= 2.5
nextflow_config - Config default value correct: params.min_length= 10
nextflow_config - Config default value correct: params.max_length= 50000
nextflow_config - Config default value correct: params.top_passes= 60
nextflow_config - Config default value correct: params.five_prime= 100
nextflow_config - Config default value correct: params.splice_junction= 10
nextflow_config - Config default value correct: params.three_prime= 100
nextflow_config - Config default value correct: params.custom_config_version= master
nextflow_config - Config default value correct: params.custom_config_base= https://raw.githubusercontent.com/nf-core/configs/master
nextflow_config - Config default value correct: params.max_cpus= 16
nextflow_config - Config default value correct: params.max_memory= 128.GB
nextflow_config - Config default value correct: params.max_time= 240.h
nextflow_config - Config default value correct: params.publish_dir_mode= copy
nextflow_config - Config default value correct: params.max_multiqc_email_size= 25.MB
nextflow_config - Config default value correct: params.validate_params= true
nextflow_config - Config default value correct: params.pipelines_testdata_base_path= https://raw.githubusercontent.com/nf-core/test-datasets/
files_unchanged - .gitattributes matches the template
files_unchanged - .prettierrc.yml matches the template
files_unchanged - CODE_OF_CONDUCT.md matches the template
files_unchanged - LICENSE matches the template
files_unchanged - .github/.dockstore.yml matches the template
files_unchanged - .github/CONTRIBUTING.md matches the template
files_unchanged - .github/ISSUE_TEMPLATE/bug_report.yml matches the template
files_unchanged - .github/ISSUE_TEMPLATE/config.yml matches the template
files_unchanged - .github/ISSUE_TEMPLATE/feature_request.yml matches the template
files_unchanged - .github/PULL_REQUEST_TEMPLATE.md matches the template
files_unchanged - .github/workflows/branch.yml matches the template
files_unchanged - .github/workflows/linting_comment.yml matches the template
files_unchanged - assets/email_template.html matches the template
files_unchanged - assets/email_template.txt matches the template
files_unchanged - assets/sendmail_template.txt matches the template
files_unchanged - assets/nf-core-isoseq_logo_light.png matches the template
files_unchanged - docs/images/nf-core-isoseq_logo_light.png matches the template
files_unchanged - docs/images/nf-core-isoseq_logo_dark.png matches the template
files_unchanged - docs/README.md matches the template
files_unchanged - .gitignore matches the template
files_unchanged - .prettierignore matches 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.yml is triggered correctly
actions_awsfulltest - .github/workflows/awsfulltest.yml does not use -profile test
readme - README Nextflow minimum version badge matched config. Badge: 23.04.0, Config: 23.04.0
readme - README Zenodo placeholder was replaced with DOI.
pipeline_name_conventions - Name adheres to nf-core convention
template_strings - Did not find any Jinja template strings (172 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
system_exit - No System.exit calls found
actions_schema_validation - Workflow validation passed: branch.yml
actions_schema_validation - Workflow validation passed: linting.yml
actions_schema_validation - Workflow validation passed: fix-linting.yml
actions_schema_validation - Workflow validation passed: download_pipeline.yml
actions_schema_validation - Workflow validation passed: release-announcements.yml
actions_schema_validation - Workflow validation passed: clean-up.yml
actions_schema_validation - Workflow validation passed: awsfulltest.yml
actions_schema_validation - Workflow validation passed: linting_comment.yml
actions_schema_validation - Workflow validation passed: awstest.yml
actions_schema_validation - Workflow validation passed: ci.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 found and not ignored.
multiqc_config - assets/multiqc_config.yml contains report_section_order
multiqc_config - assets/multiqc_config.yml contains export_plots
multiqc_config - assets/multiqc_config.yml contains report_comment
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'
base_config - conf/base.config found and not ignored.
modules_config - conf/modules.config found and not ignored.
modules_config - PBCCS found in conf/modules.config and Nextflow scripts.
modules_config - LIMA found in conf/modules.config and Nextflow scripts.
modules_config - ISOSEQ_REFINE found in conf/modules.config and Nextflow scripts.
modules_config - BAMTOOLS_CONVERT found in conf/modules.config and Nextflow scripts.
modules_config - GSTAMA_POLYACLEANUP found in conf/modules.config and Nextflow scripts.
modules_config - MINIMAP2_ALIGN found in conf/modules.config and Nextflow scripts.
modules_config - GUNZIP found in conf/modules.config and Nextflow scripts.
modules_config - GNU_SORT found in conf/modules.config and Nextflow scripts.
modules_config - ULTRA_INDEX found in conf/modules.config and Nextflow scripts.
modules_config - ULTRA_ALIGN found in conf/modules.config and Nextflow scripts.
modules_config - GSTAMA_COLLAPSE found in conf/modules.config and Nextflow scripts.
modules_config - GSTAMA_COLLAPSE found in conf/modules.config and Nextflow scripts.
modules_config - GSTAMA_FILELIST found in conf/modules.config and Nextflow scripts.
modules_config - GSTAMA_MERGE found in conf/modules.config and Nextflow scripts.
modules_config - SAMPLESHEET_CHECK found in conf/modules.config and Nextflow scripts.
modules_config - CUSTOM_DUMPSOFTWAREVERSIONS found in conf/modules.config and Nextflow scripts.
nfcore_yml - Repository type in .nf-core.yml is valid: pipeline
nfcore_yml - nf-core version in .nf-core.yml is set to the latest version: 2.14.1

Run details

nf-core/tools version 2.14.1
Run at 2024-09-05 16:00:18

nvnieuwk

Two small comments, but it LGTM if those are fixed! Good job!

main.nf

nextflow.config

@nvnieuwk

@nvnieuwk suggestion Co-authored-by: Nicolas Vannieuwkerke <101190534+nvnieuwk@users.noreply.github.com>

fellen31

Nice, just small comments!

CHANGELOG.md

fellen31 · 2024-09-05T11:30:34Z

assets/multiqc_config.yml

-  This report has been generated by the <a href="https://github.com/nf-core/isoseq/1.1.5" target="_blank">nf-core/isoseq</a>
-  analysis pipeline. For information about how to interpret these results, please see the
-  <a href="https://nf-co.re/isoseq/1.1.5/output" target="_blank">documentation</a>.
+  This report has been generated by the <a href="https://github.com/nf-core/isoseq/tree/dev" target="_blank">nf-core/isoseq</a> analysis pipeline. For information about how to interpret


bump version to version 2?

nf-core lint is expecting having dev and not 2.0.0
Should I revert to dev?

And if you link to the release tag? Like:

https://github.com/nf-core/sarek/blob/5cc30494a6b8e7e53be64d308b582190ca7d2585/assets/multiqc_config.yml#L5-L8

nf-core lint is still not happy ^^
https://github.com/nf-core/isoseq/actions/runs/10723006473/job/29735313846?pr=32#step:6:252

One last try with releases in there, https://github.com/nf-core/isoseq/releases/tag/2.0.0? Looks like that should be it https://github.com/nf-core/tools/blob/930ece572bf23b68c7a7c5259e918a878ba6499e/nf_core/lint/multiqc_config.py#L102-L105

I gave a try with 2.0.0dev and 2.0.0, still the same error :/

Alright, not sure why. I'll approve and you can decide if you want to try further or revert back to using dev. I think it's nice to have the link to the actual version in the MultiQC report though.

Thanks for your time and approval.
I'm gonna leave it to 2.0.0, as it's the target version.

docs/usage.md

main.nf

nextflow.config

conf/test_minimap2_map_entrypoint.config

sguizard · 2024-09-05T16:11:52Z

Thanks @nvnieuwk and @fellen31 for your time and reviews! :)

nf-core-bot and others added 30 commits September 25, 2023 15:16

Template update for nf-core/tools version 2.10

577073c

Template update for nf-core/tools version 2.11

b51a1fe

Template update for nf-core/tools version 2.11.1

a3cdd66

Template update for nf-core/tools version 2.12

0dbf2a4

Template update for nf-core/tools version 2.13

e7d0ce2

Template update for nf-core/tools version 2.13.1

3cb1d68

Template update for nf-core/tools version 2.14.0

dde3ebe

Template update for nf-core/tools version 2.14.1

46da05e

Merge remote-tracking branch 'origin/nf-core-template-merge-2.14.1' i…

8a999ab

…nto template_update_2.14.1

Fix samplesheet checking

7303243

restore lost file

748b01a

Updates modules and fix lint errors

9a9c75b

Update Changelog (1.1.6)

0a066cb

Update CHANGELOG.md (1.1.6)

ca7ec5a

Typos

3428e81

Fix minimap2 reference input channel

58d79db

require a meta map in newer version

Update toward Version 2.0.0

5b6be5f

give the user the possibility to start from the mapping step and do not run isoseq pre-analysis.

Update documentation

376394a

Fixed module config and multiqc_config

5c1aec3

Update README with Zenodo DOI

351de37

prettier

c3da6c6

Use nf-core test datasets to test mapping entrypoint

1888ba2

Update modules

01c2140

Fix minimap2 input channels

0e6b4fc

UPDATE: module.json

86c5d2f

Use nf-core tools dev version for linting github action

504cee9

Update nf-core command

964d3a2

remove -l option of nf-core command

6e445b0

Temp fix of linting

390d5bb

roll back to non dev nf-core tools

1a5a9d8

still fixing

f6968e6

sguizard added 6 commits August 29, 2024 12:02

update .nf-core.yml

a56fcc3

prettier

5c3b405

UPDATE: Usage.md

2c10809

UPDATE: README.md

c4c691a

UPDATE:CHANGELOG.md

a41fd1d

prettier

3f6a034

nvnieuwk approved these changes Sep 5, 2024

View reviewed changes

main.nf Outdated Show resolved Hide resolved

nextflow.config Outdated Show resolved Hide resolved

removing conda default channel

af7834c

@nvnieuwk suggestion Co-authored-by: Nicolas Vannieuwkerke <101190534+nvnieuwk@users.noreply.github.com>

fellen31 reviewed Sep 5, 2024

View reviewed changes

sguizard added 4 commits September 5, 2024 14:37

Fix part of reviewers comments

a6f7644

fix multiqc linting

a09f4f9

Try again fixing

b64b25a

Try again

283efcd

fellen31 approved these changes Sep 5, 2024

View reviewed changes

Update Changelog date and remove dev from version for release

6551adf

sguizard merged commit c7536ab into master Sep 5, 2024
10 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

nf-core/isoseq version 2 #32

nf-core/isoseq version 2 #32

sguizard commented Aug 29, 2024 •

edited

Loading

github-actions bot commented Aug 29, 2024 •

edited

Loading

❗ Test warnings:

❔ Tests ignored:

✅ Tests passed:

Run details

nvnieuwk left a comment

fellen31 left a comment

fellen31 Sep 5, 2024

sguizard Sep 5, 2024

sguizard Sep 5, 2024 •

edited

Loading

fellen31 Sep 5, 2024

sguizard Sep 5, 2024

fellen31 Sep 5, 2024

sguizard Sep 5, 2024

fellen31 Sep 5, 2024

sguizard Sep 5, 2024

sguizard commented Sep 5, 2024

Tool	Previous version	New version
bamtools/convert	2.5.2	2.5.2
isoseq	3.8.2	4.0.0
lima	2.7.1	2.9.0
minimap2/align	2.24	2.28
gnu/sort	8.25	9.3
multiqc	1.21	1.24.1

nf-core/isoseq version 2 #32

nf-core/isoseq version 2 #32

Conversation

sguizard commented Aug 29, 2024 • edited Loading

v2.0.0 - Sapphire Duck

Added

Fixed

PR checklist

github-actions bot commented Aug 29, 2024 • edited Loading

nf-core lint overall result: Passed ✅ ⚠️

❗ Test warnings:

❔ Tests ignored:

✅ Tests passed:

Run details

nvnieuwk left a comment

Choose a reason for hiding this comment

fellen31 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sguizard Sep 5, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sguizard commented Sep 5, 2024

sguizard commented Aug 29, 2024 •

edited

Loading

`Added`

`Fixed`

github-actions bot commented Aug 29, 2024 •

edited

Loading

`nf-core lint` overall result: Passed ✅ ⚠️

sguizard Sep 5, 2024 •

edited

Loading