Jw allen metadata changes - #1857
Open
jessicaway wants to merge 4 commits into
Open
Conversation
|
Remember to squash merge! |
🔍Changelog Validation Results: |
🔍Version Validation Results: |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR introduces a new optional WDL input (input_id_name, default "input_id") to let callers customize the metadata key used to store the sample identifier in H5AD outputs, while preserving backward-compatible defaults. It threads that input through Optimus, Multiome, and ATAC H5AD-generation paths and updates associated pipeline versions/changelogs.
Changes:
- Added
input_id_nameinputs and passed them into H5AD creation steps (Optimus + ATAC; Multiome threads through to both). - Bumped pipeline versions and updated
pipeline_versions.txtfor Optimus, Multiome, and ATAC; updated several warp-tools docker tags to2.7.1. - Minor repo hygiene/docs updates (AoU mitochondria changelog headings,
.gitignoreworkspace entry).
Reviewed changes
Copilot reviewed 9 out of 10 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
tasks/wdl/H5adUtils.wdl |
Adds input_id_name to Optimus-related H5AD tasks; updates default warp-tools docker tags for SmartSeq2 H5AD tasks. |
pipelines/wdl/optimus/Optimus.wdl |
Exposes input_id_name, threads it into OptimusH5adGeneration, bumps pipeline + warp-tools docker versions. |
pipelines/wdl/optimus/Optimus.changelog.md |
Adds 9.1.1 entry describing the new configurable H5AD metadata key. |
pipelines/wdl/multiome/Multiome.wdl |
Exposes input_id_name and threads it to both Optimus (GEX) and ATAC subworkflows; bumps pipeline version. |
pipelines/wdl/multiome/Multiome.changelog.md |
Adds 7.0.2 entry describing input_id_name passthrough. |
pipelines/wdl/atac/atac.wdl |
Exposes input_id_name, writes it into ATAC H5AD obs/uns, bumps pipeline + warp-tools docker versions. |
pipelines/wdl/atac/atac.changelog.md |
Adds 2.9.4 entry describing the new configurable H5AD metadata key. |
pipeline_versions.txt |
Updates recorded versions/dates for Optimus, Multiome, and atac. |
all_of_us/mitochondria/merge/mitochondria_merge.changelog.md |
Fixes missing Markdown headings for older AoU version entries. |
.gitignore |
Ignores warp.code-workspace. |
|
Remember to squash merge! |
🔍Version Validation Results: |
🔍Changelog Validation Results: |
|
Remember to squash merge! |
🔍Version Validation Results: |
🔍Changelog Validation Results: |
This file contains hidden or 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
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.
Description
This PR adds an optional input parameter that allows customization of the metadata field name used for the sample identifier stored in the H5AD outputs.
The Allen Institute requested that the identifier currently used in the H5AD output filenames (i.e. input_id) also be represented within the H5AD metadata itself. After review, we confirmed that this value is already included in the outputs under the "input_id" field.
This change makes the field name configurable so that workflows can label the value more appropriately (for example, as barcoded_cell_sample_local_name) when desired. By default, the field name remains input_id, which matches the current behavior and maintains backward compatibility.
The corresponding Warp-tools PR is here: broadinstitute/warp-tools#198