-
Notifications
You must be signed in to change notification settings - Fork 111
PD-3137 Add mitofinder to buildindices wdl #1665
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
base: develop
Are you sure you want to change the base?
Conversation
Remember to squash merge! |
🔍Changelog Validation Results:
|
🔍Version Validation Results:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR adds optional MitoFinder functionality to the BuildIndices workflow, allowing users to append mitochondrial sequence and annotations to genome references for non-human/non-mouse organisms. The changes enhance metadata recording to track MitoFinder execution details and update pipeline versioning accordingly.
- Added MitoAnnotate task to run MitoFinder with configurable inputs
- Enhanced RecordMetadata task to log MitoFinder execution status and parameters
- Updated pipeline to use MitoFinder-modified files for index building when applicable
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 5 comments.
File | Description |
---|---|
BuildIndices.wdl | Adds MitoAnnotate task, new workflow inputs, conditional logic for MitoFinder execution, and enhanced metadata recording |
BuildIndices.changelog.md | Documents the new MitoFinder functionality in version 5.1.0 |
pipeline_versions.txt | Updates BuildIndices version from 4.1.0 to 5.1.0 |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
copilot syntax suggestions Co-authored-by: Copilot <[email protected]>
Update docker tag Co-authored-by: Copilot <[email protected]>
Description
Title: Run MitoFinder optionally and Record MitoFinder execution details in metadata output
This PR enhances the
metadata.txt
output file by adding a dedicated section that records the execution status and parameters of the optional MitoFinder step.The primary changes include:
RecordMetadata
task (was_mitofinder_run
,organism
,mito_accession_used
, etc.) to accept information about the mitochondrial annotation step. Implementing conditional logic within theRecordMetadata
task's command block. It now checks if MitoFinder was run and, if so, logs all the relevant parameters used for the run. Updating the call toRecordMetadata
within the mainBuildIndices
workflow to pass the necessary variables down to the task.The motivation for this change is to improve the pipeline's provenance and traceability. Previously, the output metadata did not capture whether the optional but critical
run_mitofinder
step was performed. This made it difficult for users to know if the final genome indices included an annotated mitochondrial sequence without manually inspecting the files. This pull request solves that problem by explicitly stating in the metadata whether the step was run and detailing the exact inputs used, thus improving the clarity and reproducibility of the workflow's results.This change addresses the need for more comprehensive logging of optional pipeline steps.
Checklist
If you can answer "yes" to the following items, please add a checkmark next to the appropriate checklist item(s) and notify our WARP team by tagging @broadinstitute/warp-admins in a comment on this PR.