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

New reporting approach #10

Merged
merged 1 commit into from
Feb 27, 2024
Merged

New reporting approach #10

merged 1 commit into from
Feb 27, 2024

Conversation

milechin
Copy link
Collaborator

@milechin milechin commented Feb 8, 2024

So I discovered a nextflow function called collectFile, which opens up new opportunities for reporting. Essentially if each process creates a file, this function will collect the individual files and merge them into one file. More info here:
https://nextflow-io.github.io/patterns/collect-into-file/

So in pkgtest.nf, I updated runTests process so that it generates a csv file called test_metrics.csv with the following columns:

  • results - PASSED/FAILED value - A test will receive FAILED result if one of the following is true:

    1. If in the results.txt file contains words other than "Passed"
    2. If the exit code return by the test.qsub is not 0.
    3. If the log.txt file contains the word(s) "error". (Not sure if this will work for all tests, as some tests may have the word "error" in their summary but not indicate anything wrong.)
  • module - The name of the module

  • tests_passed - The number of "Passed" words found in the results.txt

  • tests_failed - The number of "Error" words found in the results.txt

  • log_error_count - The number of "Error" words found in the log.txt

  • exit_code - The exit code for the test.qsub execution

  • installer - The username of the installer who installed the module.

  • category - The module category

  • install_date - The install date of the module.

  • workdir - The nextflow working directory that contains the logs for the module test.

In the Workflow function, I included the collectFile function that combines the test_metrics.csv results from each process and generates a csv report in the current directory. The name of the report is the input csv file name with "report_" as a prefix.

In this commit I am including an example output report called report_example.csv for review.

Copy link
Collaborator

@aramp10 aramp10 left a comment

Choose a reason for hiding this comment

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

I like the report_example.csv table, it's simple and easy to sort by the columns. This would be a good way to see the results of the many tests that we plan to run.

Copy link
Collaborator

@bu-bgregor bu-bgregor left a comment

Choose a reason for hiding this comment

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

reviewed during meeting, approved :)

@milechin milechin merged commit 5e04e5f into develop Feb 27, 2024
@milechin milechin deleted the tuning branch February 27, 2024 21:23
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

3 participants