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

Directories/restructuring #66

Merged
merged 46 commits into from
May 6, 2024
Merged

Directories/restructuring #66

merged 46 commits into from
May 6, 2024

Conversation

mattheww95
Copy link
Collaborator

Restruction of directories and outputs so that the outputs name conveys more meaning to users, and output tag types are added to file names.

The output directories have been updated but tests have not been. Additionally the output folder structure is modifiable within the modules.config file at the top level to fit in with the other pipelines, I think it is a cleaner way of specifying things as well. Tests have not been updated yet, however they will be after the module output names have been updated too reflect the process used to run them. As the tests will have to be updated twice otherwise.

Additionally, the length filtered contigs are now set as the output contigs for follow up processes as they were not previously
Sadly while files are being renamed, some more tact was required in the process as I have inadverntly merged began oblititerating some outputs. The closure was updated to hopefully address this issue but more testing is needed
This is not a real commit, but the quast container is having issues running for some reason (once again with gridss). As the tests complete successfully in CI and the goal here to determine that the new outputs in some of the tests are coordinated we I just want to see what fails in github
Copy link

github-actions bot commented Apr 18, 2024

nf-core lint overall result: Passed ✅ ⚠️

Posted for pipeline commit 947f21b

+| ✅ 157 tests passed       |+
#| ❔  31 tests were ignored |#
!| ❗   3 tests had warnings |!

❗ Test warnings:

  • nextflow_config - Config manifest.version should end in dev: 0.1.2
  • readme - README contains the placeholder zenodo.XXXXXXX. This should be replaced with the zenodo doi (after the first release).
  • schema_lint - Schema $id should be https://raw.githubusercontent.com/phac-nml/mikrokondo/master/nextflow_schema.json
    Found https://raw.githubusercontent.com/phac-nml/mikrokondo/main/nextflow_schema.json

❔ Tests ignored:

  • files_exist - File is ignored: CODE_OF_CONDUCT.md
  • files_exist - File is ignored: assets/nf-core-mikrokondo_logo_light.png
  • files_exist - File is ignored: docs/images/nf-core-mikrokondo_logo_light.png
  • files_exist - File is ignored: docs/images/nf-core-mikrokondo_logo_dark.png
  • files_exist - File is ignored: .github/ISSUE_TEMPLATE/config.yml
  • files_exist - File is ignored: .github/workflows/awstest.yml
  • files_exist - File is ignored: .github/workflows/awsfulltest.yml
  • files_exist - File is ignored: docs/output.md
  • files_exist - File is ignored: docs/README.md
  • files_exist - File is ignored: docs/usage.md
  • nextflow_config - Config variable ignored: manifest.name
  • nextflow_config - Config variable ignored: manifest.homePage
  • files_unchanged - File does not exist: CODE_OF_CONDUCT.md
  • 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 does not exist: .github/ISSUE_TEMPLATE/config.yml
  • files_unchanged - File ignored due to lint config: .github/ISSUE_TEMPLATE/feature_request.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: .github/workflows/linting.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-mikrokondo_logo_light.png
  • files_unchanged - File does not exist: docs/images/nf-core-mikrokondo_logo_light.png
  • files_unchanged - File does not exist: docs/images/nf-core-mikrokondo_logo_dark.png
  • files_unchanged - File does not exist: docs/README.md
  • files_unchanged - File ignored due to lint config: .gitignore or .prettierignore or pyproject.toml
  • actions_awstest - 'awstest.yml' workflow not found: /home/runner/work/mikrokondo/mikrokondo/.github/workflows/awstest.yml
  • multiqc_config - multiqc_config

✅ Tests passed:

Run details

  • nf-core/tools version 2.13.1
  • Run at 2024-05-06 19:46:41

@mattheww95 mattheww95 force-pushed the directories/restructuring branch from 3828a45 to 4672712 Compare April 18, 2024 19:53
@mattheww95
Copy link
Collaborator Author

This PR has expanded in scope sadly (that is my fault). But the directories structure and naming of outputs has been updated along with the tests. Contigs that are filtered are now passed to other quality processes after filtering which addresses issue #55 and resulted in the addition of another parameter for skipping outputs. The IRIDANext config has been updated to reflect the updated output names and locations, however there is a chance that some outputs have been missed.

@mattheww95 mattheww95 marked this pull request as ready for review April 22, 2024 14:56
@mattheww95 mattheww95 requested review from apetkau and emarinier April 22, 2024 14:56
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.

Thanks so much @mattheww95 for the amazing work you've put into this 😄 . A few comments.

CHANGELOG.md Outdated Show resolved Hide resolved
bin/kraken2_bin.py Outdated Show resolved Hide resolved
modules/local/checkm_lineagewf.nf Show resolved Hide resolved
subworkflows/local/clean_reads.nf Show resolved Hide resolved
subworkflows/local/qc_assemblies.nf Show resolved Hide resolved
conf/modules.config Show resolved Hide resolved
conf/modules.config Show resolved Hide resolved
Copy link
Member

@emarinier emarinier left a comment

Choose a reason for hiding this comment

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

Other than the things Aaron pointed out, and some English-related things I pointed out, it looks okay to me.

docs/subworkflows/hybrid_assembly.md Outdated Show resolved Hide resolved
docs/subworkflows/input_check.md Outdated Show resolved Hide resolved
docs/subworkflows/subtype_genome.md Outdated Show resolved Hide resolved
docs/workflows/PostAssembly.md Outdated Show resolved Hide resolved
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. I tested it with IRIDA Next and it works.

I have one comment.

CHANGELOG.md Outdated Show resolved Hide resolved
@apetkau apetkau mentioned this pull request May 6, 2024
@mattheww95 mattheww95 merged commit 81e7ccc into dev May 6, 2024
4 checks passed
@mattheww95 mattheww95 deleted the directories/restructuring branch May 6, 2024 20:17
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