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

[Style Guide] Semantic adjustments throughout the PHB universe #377

Closed cimendes closed 3 months ago

cimendes commented 4 months ago

This PR closes #365 and closes #366 and closes #367 and closes #368.

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

:brain: Aim, Context and Functionality

This PR aims to harmonize a few inputs in workflows and sub-workflows to better adhere to our style-guide!

: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, it changes only input parameters. Default JSON inputs will need to be updated

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

Please see Files changed for an exhaustive list of all the inputs that were adjusted!

:clipboard: Workflow/Task Step Changes

🔄 Data Processing

Docker/software or software versions changed: None

Databases or database versions changed: None

Data processing/commands changed: None

File processing changed: None

Compute resources changed: None

➡️ Inputs

⬅️ Outputs

None

:test_tube: Testing

Test Dataset

Commandline Testing with MiniWDL or Cromwell (optional)

Skipped in favour if testing in Terra!

Terra Testing

In the comments below!

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 4 months ago

@sage-wright I'm setting this as ready to review as I could use the help in testing it!

cimendes commented 4 months ago

Propagation of new input parameters check and validation!

cimendes commented 4 months ago

Propagation of new input parameters check and validation! (Continued)

sage-wright commented 4 months ago

@cimendes when we have _minlength do you think it makes sense to change that to _min_length; same for maxlength -> max_length

cimendes commented 4 months ago

@cimendes when we have _minlength do you think it makes sense to change that to _min_length; same for maxlength -> max_length

Ops, sorry I missed this message! It is now done!

sage-wright commented 3 months ago
sage-wright commented 3 months ago

Yay! Good job.