theiagen / public_health_bioinformatics

Bioinformatics workflows for genomic characterization, submission preparation, and genomic epidemiology of pathogens of public health concern.
GNU General Public License v3.0
37 stars 17 forks source link

TheiaValidate: Compare file contents (#264) #335

Closed sage-wright closed 7 months ago

sage-wright commented 8 months ago

This PR closes the loop on the adding file comparisons to TheiaValidate

🗑️ This dev branch should be deleted after merging to main.

:brain: Aim, Context and Functionality

This PR pushes the changes into main that have been thoroughly tested as part of #264

:hammer_and_wrench: Impacted Workflows/Tasks & Changes Being Made

This will affect the behavior of the workflow(s) even if users don’t change any workflow inputs relative to the last version : No

Running this workflow on different occasions could result in different results, e.g. due to use of a live database, "latest" docker image, or stochastic data processing : No

:clipboard: Workflow/Task Step Changes

🔄 Data Processing

Docker/software or software versions changed:

TheiaValidate updated to now compare files

Databases or database versions changed:

Data processing/commands changed:

File processing changed:

Compute resources changed:

➡️ Inputs

⬅️ Outputs

File comparison outputs now created

:test_tube: Testing

Test Dataset

Commandline Testing with MiniWDL or Cromwell (optional)

Terra Testing

Suggested Scenarios for Reviewer to Test

Theiagen Version Release Testing (optional)

:microscope: Final Developer Checklist

🎯 Reviewer Checklist

🗂️ Associated Documentation (to be completed by Theiagen developer)

cimendes commented 7 months ago

Optional inputs present as expected: image

cimendes commented 7 months ago

New outputs present as expected: image

cimendes commented 7 months ago

Testing on two identical kraken2 report files here: https://app.terra.bio/#workspaces/theiagen-validations/Theiagen_Mendes_Sandbox/job_history/d590d67a-f893-469e-a281-f1126dc13407

cimendes commented 7 months ago

@sage-wright the documentation update is missing for the input and output variables. Do you want to take care of that or should I?

cimendes commented 7 months ago

image image

🌟 Validation worked as expected! 🌟 Approving once documentation is updated!

sage-wright commented 7 months ago

@cimendes, docs have been updated!

cimendes commented 7 months ago

@cimendes, docs have been updated!

Thank you!!! Approving and merging!