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

TheiaProk TB: new VCF output and modification to the coverage report #245

Merged
merged 24 commits into from
Dec 29, 2023

Conversation

sage-wright
Copy link
Member

@sage-wright sage-wright commented Nov 13, 2023

DO NOT MAKE CHANGES TO THIS BRANCH!!!!!!!

closes #283

I recognize Frank made a branch that alters some parameters, so those might need to be incorporated, but these were the latest iteration of changes I made to the TB analysis pathway.

🛠️ Changes Being Made

This PR:

  • merges all VCF files produced by TBProfiler and returns the merged VCF to the Terra table
  • updates the tbp-parser Docker image
  • prefixes each row of the coverage report with the sample name

Impacted Workflows/Tasks

Tasks:

  • tasks/species_typing/task_tbp_parser.wdl
  • tasks/species_typing/task_tbprofiler.wdl

Workflows:

  • workflows/theiaprok/wf_theiaprok_illumina_pe.wdl
  • workflows/theiaprok/wf_theiaprok_illumina_se.wdl
  • workflows/theiaprok/wf_theiaprok_ont.wdl
  • workflows/utiltiies/wf_merlin_magic.wdl

🧠 Context and Rationale

Changes were requested by users.

📋 Workflow/Task Steps

  • After tbp-parser runs, the samplename is added in front of every row in the coverage report produced by tbp-parser.
  • After TBProfiler runs, bcftools indexes and merges all potential VCF files created (both .bcf and .gz files)

Inputs

No inputs were changed

Outputs

New output: tbprofiler_output_vcf

Impacted Outputs

Modified outputs:

  • tbp_parser_coverage_report
  • tbp_parser_docker
  • tbp_parser_version

Additional changes were made in the tbp-parser output files due to changes associated with the updated Docker image.

🧪 Testing

Locally

Terra

Scenarios for Reviewer to Test

🔬 Quality checks

Pull Request (PR) checklist:

  • Include a description of what is in this pull request in this message.
  • The workflow/task has been tested locally and on Terra
  • The CI/CD has been adjusted and tests are passing
  • Everything follows the style guide

frankambrosio3 and others added 14 commits November 13, 2023 15:37
* updated VCF output file renaming in kSNP3 task (#207)

* updated VCF output file renaming in kSNP3 task; also added 1 new File output and change the output names to be more descriptive

* ksnp3 task:changed VCF file names to be predictable; split 2 ksnp3 options to 2 lines for readability; added new string output "ksnp3_vcf_ref_samplename" to capture sample within cluster to use for snp calling

* added new string output to ksnp3 workflow "ksnp3_vcf_ref_samplename"

* reduce unnecessary logging in MIDAS task (#210)

* made untar/decompression of midas database quiet since it produces 41k lines of output. also made the 2 mv commands verbose (but it's only 2 lines!)

* update CI

* expose tbprofiler parameters as inputs in merlin

* input spelling

---------

Co-authored-by: Curtis Kapsak <kapsakcj@gmail.com>
@sage-wright sage-wright marked this pull request as draft December 11, 2023 14:40
@sage-wright sage-wright marked this pull request as ready for review December 19, 2023 20:24
@@ -9,7 +9,7 @@ task version_capture {
volatile: true
}
command {
PHB_Version="PHB v1.2.1"
PHB_Version="PHB v1.2.1: smw-tb-2023-10-25-dev branch"
Copy link
Contributor

Choose a reason for hiding this comment

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

Will need to modify before merge

@kevinlibuit kevinlibuit merged commit 7177fbb into main Dec 29, 2023
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.

Merge TB changes into main
3 participants