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

Workflow #4

Merged
merged 16 commits into from
Apr 4, 2024
Merged

Workflow #4

merged 16 commits into from
Apr 4, 2024

Conversation

mattheww95
Copy link
Collaborator

@mattheww95 mattheww95 commented Apr 2, 2024

Created an initial workflow and added basic tests, with some data. Linting will likely fail as I have not updated the nextflow_schema.json yet.

Matthew Wells added 2 commits April 2, 2024 16:09
Implemented the initial workflow, it is likely that many changes will need to be made. However I am focusing on implementing working unit-tests for the time being
I added some unit tests to the pipeline however these tests are incomplete, and show some current work that needs to be done in terms of altering the output paths as they are quite messy currently. Additionally more tests with the existing data can be added as it woul really improve the robustness of the pipeline
@mattheww95 mattheww95 requested a review from emarinier April 2, 2024 21:25
Copy link

github-actions bot commented Apr 2, 2024

nf-core lint overall result: Passed ✅ ⚠️

Posted for pipeline commit 7ce6e9f

+| ✅ 140 tests passed       |+
#| ❔  22 tests were ignored |#
!| ❗  15 tests had warnings |!

❗ Test warnings:

  • schema_lint - Schema $id should be https://raw.githubusercontent.com/phac-nml/gasnomenclature/master/nextflow_schema.json
    Found https://raw.githubusercontent.com/phac-nml/gasnomenclature/main/nextflow_schema.json
  • schema_description - No description provided in schema for parameter: gm_thresholds
  • schema_description - No description provided in schema for parameter: gm_delimiter
  • schema_description - No description provided in schema for parameter: ref_clusters
  • schema_description - No description provided in schema for parameter: pd_outfmt
  • schema_description - No description provided in schema for parameter: pd_distm
  • schema_description - No description provided in schema for parameter: pd_missing_threshold
  • schema_description - No description provided in schema for parameter: pd_sample_quality_threshold
  • schema_description - No description provided in schema for parameter: pd_match_threshold
  • schema_description - No description provided in schema for parameter: pd_file_type
  • schema_description - No description provided in schema for parameter: pd_mapping_file
  • schema_description - No description provided in schema for parameter: pd_force
  • schema_description - No description provided in schema for parameter: pd_skip
  • schema_description - No description provided in schema for parameter: pd_columns
  • schema_description - No description provided in schema for parameter: pd_count_missing

❔ Tests ignored:

  • files_exist - File is ignored: assets/nf-core-gasnomenclature_logo_light.png
  • files_exist - File is ignored: docs/images/nf-core-gasnomenclature_logo_dark.png
  • files_exist - File is ignored: docs/images/nf-core-gasnomenclature_logo_light.png
  • files_exist - File is ignored: .github/workflows/awstest.yml
  • files_exist - File is ignored: .github/workflows/awsfulltest.yml
  • 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-gasnomenclature_logo_light.png
  • files_unchanged - File does not exist: docs/images/nf-core-gasnomenclature_logo_light.png
  • files_unchanged - File does not exist: docs/images/nf-core-gasnomenclature_logo_dark.png
  • files_unchanged - File ignored due to lint config: docs/README.md
  • actions_awstest - 'awstest.yml' workflow not found: /home/runner/work/gasnomenclature/gasnomenclature/.github/workflows/awstest.yml
  • actions_awsfulltest - actions_awsfulltest
  • pipeline_name_conventions - pipeline_name_conventions

✅ Tests passed:

Run details

  • nf-core/tools version 2.13.1
  • Run at 2024-04-03 16:16:17

@mattheww95 mattheww95 marked this pull request as ready for review April 3, 2024 14:42
@mattheww95
Copy link
Collaborator Author

mattheww95 commented Apr 3, 2024

Linting tests are failing as I did not update the schema. I wanted prioritize getting the main "bones" of the pipeline in with test data so that critical feedback can be provided on the structure of the pipeline itself to make sure it fits what is expected.

I did not set up the irida-next.conf either yet as well, as I think the output paths will change and we may want to discuss what is stored in terms of data being parsed as metadata for IRIDA Next.

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.

I think the changes here look good overall. I have some general comments:

  • It might be worth adding failure / error testing.
  • Generally, I'd advise against merging any TODOs into a dev / main branch, and instead do the TODO or make an issue on GitHub to do it later.
  • I assume we're going forward with default parameters all listed in the nextflow.config?

@emarinier
Copy link
Member

Oh, also getting the tests to pass.

@mattheww95
Copy link
Collaborator Author

Good news all tests passed!

I am not proud of it, but to resolve the TODO I changed it to a point for discussion.

As for the defualt parameters, I dont know how most of the parameters to be passed to the tools are meant to be used so I just left them there for now.

I can add failure testing as well! I just thought it would be better to leave that as a seperate PR, I just wanted to get the initial skeleton of the tests implemented and full disclosure I was going to bug you about those afterwards...

@mattheww95 mattheww95 merged commit dccc794 into dev Apr 4, 2024
4 checks passed
@mattheww95 mattheww95 deleted the workflow branch April 4, 2024 20:15
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.

2 participants