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
33 stars 15 forks source link

adding optional arguments to freyja boot and demix calls #371

Closed jrotieno closed 3 months ago

jrotieno commented 4 months ago

This PR closes #350.

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

:brain: Aim, Context and Functionality

This PR adds additional optional inputs depth_cutoff to the Freyja_FASTQ_PHB workflow. This gives the user the option to exclude sites with coverage depth below this value and group identical barcodes.

:hammer_and_wrench: Impacted Workflows/Tasks & Changes Being Made

Freyja_FASTQ_PHB task_freyja_one sample.wdl

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 : Yes, but has nothing to do with this PR

:clipboard: Workflow/Task Step Changes

🔄 Data Processing

Docker/software or software versions changed: No

Databases or database versions changed: No

Data processing/commands changed: Yes

File processing changed: No

Compute resources changed: No

➡️ Inputs

we have added a new output depth_coverage

⬅️ Outputs

No outputs changed

:test_tube: Testing

Test Dataset

Commandline Testing with MiniWDL or Cromwell (optional)

Not undertaken

Terra Testing

The dataset used is the validation dataset labelled freyja_sc2

Note, there are two expected sample failures, i.e. ERR9829562 and SRR3982099

No optional inputs changed: https://app.terra.bio/#workspaces/cdph-terrabio-taborda-manual/Global_tree_testing/job_history/9aaca3c6-5ab7-49c9-a4ea-c89b916be573

depth_cutoff set to 5: https://app.terra.bio/#workspaces/cdph-terrabio-taborda-manual/Global_tree_testing/job_history/d1a51258-324e-42e5-b1d4-39f89bbcd878

depth_cutoff set to 1000000: https://app.terra.bio/#workspaces/cdph-terrabio-taborda-manual/Global_tree_testing/job_history/1604eb8f-0e25-4d89-a1b9-5934ee3f0f1a

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)

michellescribner commented 3 months ago

Tested new depth_cutoff input: https://app.terra.bio/#workspaces/theiagen-validations/Theiagen_Scribner_Sandbox/job_history/02ab8d71-c852-473e-9fb9-5b767a57643e

Also tested confirmed_only boolean with depth_cutoff: https://app.terra.bio/#workspaces/theiagen-validations/Theiagen_Scribner_Sandbox/job_history/44011ceb-ba53-4da4-b5e0-9f7df9efa492

Both completed successfully.