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

[Mercury_Prep_N_Batch] Enable flu compatibility and move Mercury into its own GitHub repository #506

Closed sage-wright closed 1 month ago

sage-wright commented 3 months ago

This PR closes #432.

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

:brain: Aim, Context and Functionality

The main Mercury_Prep_N_Batch task was becoming excessively long and was due to become its own Python repository, which it now is, see here!.

In addition, Mercury now processes BioSample & SRA metadata for influenza.

: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 : Yes

This PR is a revamp of the Mercury_Prep_N_Batch workflow, with clarifications made to input parameters, although all outputs remain the same.

:clipboard: Workflow/Task Step Changes

🔄 Data Processing

Docker/software or software versions changed:

Databases or database versions changed:

Data processing/commands changed:

File processing changed:

Compute resources changed:

➡️ Inputs

variables with name changes:

old new
table_name terra_table_name
workspace_name terra_workspace_name
project_name terra_project_name

new locations:

new defaults:

removed inputs:

⬅️ Outputs

none!

Curtis edit: New output: String mercury_script_version which is the version of the Mercury python script/package used within the workflow.

:test_tube: Testing

Test Dataset

NEEDS TESTING!!!

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)

kapsakcj commented 1 month ago

I queued another test with Flu here: https://app.terra.bio/#workspaces/theiagen-validations/curtis-sandbox-theiagen-validations/job_history/9976680c-dec1-4a4d-91e1-4c4df8c73aaa

Also reached out to our PHL partner to request additional feedback. Will ping back when I hear from them.

kapsakcj commented 1 month ago

documentation looks great, thanks for revamping it! Merging now and we will delete the dev branch in 2 weeks time