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

Template update for nf-core/tools v2.13.1 #26

Merged
merged 13 commits into from
Mar 21, 2024

Conversation

jmuhlich
Copy link
Member

Resolved conflicts in automated PR.

Copy link

github-actions bot commented Mar 19, 2024

nf-core lint overall result: Passed ✅ ⚠️

Posted for pipeline commit fb4273e

+| ✅ 167 tests passed       |+
!| ❗  26 tests had warnings |!

❗ Test warnings:

  • nextflow_config - Config manifest.version should end in dev: 2.0.0
  • readme - README contains the placeholder zenodo.XXXXXXX. This should be replaced with the zenodo doi (after the first release).
  • pipeline_todos - TODO string in nextflow.config: Specify your pipeline's command line flags
  • pipeline_todos - TODO string in README.md: TODO nf-core:
  • pipeline_todos - TODO string in README.md: Include a figure that guides the user through the major workflow steps. Many nf-core
  • pipeline_todos - TODO string in README.md: Fill in short bullet-pointed list of the default steps in the pipeline
  • pipeline_todos - TODO string in README.md: Describe the minimum required steps to execute the pipeline, e.g. how to prepare samplesheets.
  • pipeline_todos - TODO string in README.md: update the following command to include all required parameters for a minimal example
  • pipeline_todos - TODO string in README.md: If applicable, make list of people who have also contributed
  • pipeline_todos - TODO string in README.md: Add citation for pipeline after first release. Uncomment lines below and update Zenodo doi and badge at the top of this file.
  • pipeline_todos - TODO string in README.md: Add bibliography of tools and data used in your pipeline
  • pipeline_todos - TODO string in ci.yml: You can customise CI pipeline run tests as required
  • pipeline_todos - TODO string in awsfulltest.yml: You can customise AWS full pipeline tests as required
  • 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!
  • pipeline_todos - TODO string in usage.md: Add documentation about anything specific to running your pipeline. For general topics, please point to (and add to) the main nf-core website.
  • pipeline_todos - TODO string in output.md: Write this documentation describing your workflow's output
  • 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 test_full.config: Specify the paths to your full test data ( on nf-core/test-datasets or directly in repositories, e.g. SRA)
  • pipeline_todos - TODO string in test_full.config: Give any required params for the test so that command line flags are not needed
  • pipeline_todos - TODO string in base.config: Check the defaults for all processes
  • pipeline_todos - TODO string in base.config: Customise requirements for specific processes.
  • pipeline_todos - TODO string in test.config: Specify the paths to your test data on nf-core/test-datasets
  • pipeline_todos - TODO string in test.config: Give any required params for the test so that command line flags are not needed
  • schema_description - No description provided in schema for parameter: illumination

✅ Tests passed:

Run details

  • nf-core/tools version 2.13.1
  • Run at 2024-03-21 15:43:56

This was added by us but now it's causing a lint error. I don't see this entry
in the schema of any other pipelines so it is probably safe to remove.
This change removes the hard-coded local input paths in the top level workflow
and replaces them with values read from an actual sample sheet. The test
profile has been modified to pass in a minimal sample sheet. The ashlar
module was updated to fix a bug that crashed the versions.yml parser.

The marker csv URL is not ideal but using the one from test-datasets would
have required a more wholesale rewriting of the sample sheet organization.
That rewrite had already been implemented in a separate branch to be merged as
soon as this template update is accepted.
Copy link

@kbestak kbestak left a comment

Choose a reason for hiding this comment

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

Overall it looks great, left some small comments.

I just want to highlight that in the Gitpod environment, the pipeline fails (nextflow run . -profile docker,test) due to an ongoing bug with the MultiQC container (fails to pull in Gitpod for versions 1.18 and above).

I also got a linting error in Gitpod for the logo changes (files_unchanged), but it seems to pass the CI linting test.

}

process {
withName: ".*:DEEPCELL_MESMER" {
Copy link

Choose a reason for hiding this comment

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

Why is ".*:DEEPCELL_MESMER" required instead of just "DEEPCELL_MESMER"?

Copy link
Member Author

Choose a reason for hiding this comment

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

I tried just the simple module name but the settings weren't applied! You can see the failed CI run on the previous commit where I didn't have the wildcard match. 🤣

saveAs: { filename -> filename.equals('versions.yml') ? null : filename }
]
}

withName: CUSTOM_DUMPSOFTWAREVERSIONS {
Copy link

Choose a reason for hiding this comment

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

CUSTOM_DUMPSOFTWAREVERSIONS is also removed with the new template so that section can also be excluded here.

Copy link
Member Author

Choose a reason for hiding this comment

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

Good catch, done.

Copy link

Choose a reason for hiding this comment

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

Since fastqc generally won't be used by this pipeline, I think it should be excluded. Nothing critical right now and I understand how keeping it would make soon to be released template updates slightly easier to merge.

Copy link
Member Author

Choose a reason for hiding this comment

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

Another good catch, also done.

@jmuhlich
Copy link
Member Author

I noticed the local lint failure on the images too. I just ran nf-core lint --fix and it did update the images (minor text kerning change). I've committed that change here and we'll see if it passes.

@jmuhlich jmuhlich force-pushed the nf-core-template-merge-2.13.1 branch from 063c5a2 to fb4273e Compare March 21, 2024 15:42
@jmuhlich
Copy link
Member Author

Nope, with those updated images the CI lint check fails! I force-pushed the previous commit so all checks should be passing again.

@jmuhlich
Copy link
Member Author

I found some people in Slack who had the same inconsistency issues with nf-core lint and the logos. I submitted an issue with my findings: nf-core/tools#2893

@josenimo
Copy link

I can't speak for the details of the groovy code, slowly getting into it, but in general I really like the subworkflows that check input and format output. It is much more intuitive, at least for me :). Great work @jmuhlich

Copy link

@kbestak kbestak left a comment

Choose a reason for hiding this comment

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

Great, LGTM!
Not sure about the expected tests yet, though

@jmuhlich
Copy link
Member Author

I think the EditorConfig and Prettier tests were previously required but have been phased out with the new tools update, so they'll never be run here. I'll ask some nf-core folks how to proceed.

@jmuhlich
Copy link
Member Author

I can't speak for the details of the groovy code, slowly getting into it, but in general I really like the subworkflows that check input and format output. It is much more intuitive, at least for me :). Great work @jmuhlich

Thanks Jose! Those new subworkflows are all from the new nf-core tools release and template updates, so all credit to the tools team.

@jmuhlich
Copy link
Member Author

OK! Maxime adjusted our required checks to remove the stale ones, so we're good to go.

@jmuhlich jmuhlich merged commit 5ab80be into nf-core:dev Mar 21, 2024
6 of 8 checks passed
@jmuhlich jmuhlich deleted the nf-core-template-merge-2.13.1 branch March 21, 2024 17:21
@jmuhlich jmuhlich mentioned this pull request Mar 21, 2024
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.

None yet

4 participants