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

Update/input assure to accommodate changes in locidex mlst.json allele reports #28

Merged
merged 20 commits into from
Aug 21, 2024

Conversation

kylacochrane
Copy link
Contributor

@kylacochrane kylacochrane commented Aug 15, 2024

This PR upgrades the version of the locidex/merge module to locidex:0.2.2 in the container directive. The new version of locidex includes changes to the formatting of generated mlst.json allele report files (such as those outputted from Mikrokondo).

To ensure compatibility, the input_assure module and python script have been updated to accommodate these changes in the mlst.json allele reports. The test data has also been updated to reflect the new mlst.json format. All pipeline tests are passing.

New mlst.json formatting:
image

Additionally, container directives and closures have been aligned with the phac-nml/pipeline-standards as outlined in the Module Software Requirements and Container Registres

PR checklist

  • This comment contains a description of changes (with reason).
  • Make sure your code lints (nf-core lint).
  • Ensure the test suite passes (nextflow run . -profile test,docker --outdir <OUTDIR>).
  • Check for unexpected warnings in debug mode (nextflow run . -profile debug,test,docker --outdir <OUTDIR>).
  • CHANGELOG.md is updated.

Copy link

github-actions bot commented Aug 15, 2024

nf-core lint overall result: Passed ✅ ⚠️

Posted for pipeline commit cf5248e

+| ✅ 147 tests passed       |+
#| ❔  27 tests were ignored |#
!| ❗   2 tests had warnings |!

❗ Test warnings:

  • nextflow_config - Config manifest.version should end in dev: 0.3.0
  • schema_lint - Schema $id should be https://raw.githubusercontent.com/phac-nml/gasclustering/master/nextflow_schema.json
    Found https://raw.githubusercontent.com/phac-nml/gasclustering/main/nextflow_schema.json

❔ Tests ignored:

  • files_exist - File is ignored: assets/nf-core-gasclustering_logo_light.png
  • files_exist - File is ignored: docs/images/nf-core-gasclustering_logo_light.png
  • files_exist - File is ignored: docs/images/nf-core-gasclustering_logo_dark.png
  • files_exist - File is ignored: .github/workflows/awstest.yml
  • files_exist - File is ignored: .github/workflows/awsfulltest.yml
  • files_exist - File is ignored: lib/Utils.groovy
  • files_exist - File is ignored: lib/WorkflowMain.groovy
  • files_exist - File is ignored: lib/NfcoreTemplate.groovy
  • files_exist - File is ignored: lib/WorkflowGasclustering.groovy
  • nextflow_config - Config variable ignored: manifest.name
  • nextflow_config - Config variable ignored: manifest.homePage
  • files_unchanged - File ignored due to lint config: LICENSE or LICENSE.md or LICENCE or LICENCE.md
  • files_unchanged - File ignored due to lint config: .github/CONTRIBUTING.md
  • files_unchanged - File ignored due to lint config: .github/ISSUE_TEMPLATE/bug_report.yml
  • files_unchanged - File ignored due to lint config: .github/PULL_REQUEST_TEMPLATE.md
  • files_unchanged - File ignored due to lint config: .github/workflows/branch.yml
  • files_unchanged - File ignored due to lint config: assets/email_template.html
  • files_unchanged - File ignored due to lint config: assets/email_template.txt
  • files_unchanged - File ignored due to lint config: assets/sendmail_template.txt
  • files_unchanged - File does not exist: assets/nf-core-gasclustering_logo_light.png
  • files_unchanged - File does not exist: docs/images/nf-core-gasclustering_logo_light.png
  • files_unchanged - File does not exist: docs/images/nf-core-gasclustering_logo_dark.png
  • files_unchanged - File ignored due to lint config: docs/README.md
  • files_unchanged - File ignored due to lint config: .gitignore or .prettierignore
  • actions_awstest - 'awstest.yml' workflow not found: /home/runner/work/gasclustering/gasclustering/.github/workflows/awstest.yml
  • actions_awsfulltest - actions_awsfulltest
  • pipeline_name_conventions - pipeline_name_conventions

✅ Tests passed:

Run details

  • nf-core/tools version 2.14.1
  • Run at 2024-08-21 20:52:16

@kylacochrane kylacochrane marked this pull request as ready for review August 20, 2024 14:26
Copy link
Member

@apetkau apetkau left a comment

Choose a reason for hiding this comment

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

This is amazing work @kylacochrane 😄 . Thanks so much for all these changes. I have only a few comments.

CHANGELOG.md Outdated Show resolved Hide resolved
bin/input_assure.py Outdated Show resolved Hide resolved
bin/input_assure.py Outdated Show resolved Hide resolved
Copy link

@sgsutcliffe sgsutcliffe left a comment

Choose a reason for hiding this comment

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

Looks good! In the reviewing the changes I noticed indirectly that the .mlst.json file is not described in README.md or docs/usage.md, adding it might not be in the scope of this PR. I could create an issue if you think it is a good idea.

@kylacochrane
Copy link
Contributor Author

@sgsutcliffe That would be fantastic! Creating an issue for this would be really helpful. I agree that it is important to add some information about the mlst.json files and locidex to the README to ensure everything is clear. Thanks for the suggestion!!

Copy link
Member

@apetkau apetkau left a comment

Choose a reason for hiding this comment

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

This looks great. Thanks so much Kyla 😄

@@ -3,6 +3,15 @@
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [0.3.0] - 2024-08-21
Copy link
Member

Choose a reason for hiding this comment

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

Could you also add the link to this tag like the other releases, even if the tag isn't created yet (in anticipation of when we release)?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done here: cf5248e
😃

@kylacochrane kylacochrane merged commit 1042780 into dev Aug 21, 2024
4 checks passed
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.

3 participants