-
Notifications
You must be signed in to change notification settings - Fork 24
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
Improvement: Add WDL Workflow for Automated IGV Screenshots with Customizable Resources and Inputs #472
Draft
shadizaheri
wants to merge
49
commits into
main
Choose a base branch
from
sz_igv_more_inputs
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…output/IGV_Snapshots
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
This PR introduces a new WDL workflow to automate the generation of IGV (Integrative Genomics Viewer) screenshots. The workflow allows users to input multiple BAM files, VCF files, and optional haplotype-specific alignments for visualization. Additionally, it includes options to customize memory, disk size, and snapshot height, ensuring flexibility for various use cases.
Key Features
Multi-file Support: Handles multiple BAM files, including haplotypes (truth_haplotype_1, truth_haplotype_2, 8x-hap1, 8x-hap2), and a targeted VCF (TRGT_VCF) for comprehensive visualization.
Customizable Resource Allocation: Users can specify memory, disk size, and image height to optimize the workflow for their dataset size and computational environment.
Optional Inputs: Some inputs such as haplotype BAM files and VCF are optional, providing flexibility in the use of this workflow across different projects.
Direct Screenshot Outputs: Outputs IGV screenshots directly as an array of PNG files, making it easy to review and download individual images.
Changes Included
New WDL Workflow (IGVScreenshotWorkflow): A workflow to automate IGV screenshot generation using a Python script.
Task (RunIGVScreenshot): A task that executes the IGV Python script within a Docker container, with support for a virtual display (Xvfb).
Updated Documentation: Includes documentation in the WDL script header for easy understanding and usage.
Usage
How to Test
Run the Workflow: Execute the WDL workflow on Terra or a WDL-compatible execution environment.
Check Outputs: Verify that the screenshots are generated correctly in the specified output directory, and ensure optional files are handled as expected.
Resource Customization: Test the workflow with different image_height, memory_mb, and disk_gb values to confirm customization works.
Potential Use Cases
Additional Notes
The Docker image used in this workflow is us.gcr.io/broad-dsp-lrma/igv_screenshot_docker:v9172024.
This workflow is designed for flexibility and can be adapted to various genomic visualization needs.