Skip to content

Update version, dependencies, and improve file checks#94

Merged
willisbillis merged 6 commits into
devfrom
main
Jul 23, 2025
Merged

Update version, dependencies, and improve file checks#94
willisbillis merged 6 commits into
devfrom
main

Conversation

@willisbillis

@willisbillis willisbillis commented Jul 23, 2025

Copy link
Copy Markdown
Owner

Reflect updates in the version and release date in CITATION.cff. Enhance the environment configuration for Ubuntu. Improve data processing scripts by adding file existence checks and logging warnings for missing files. Adjust grouping variables in VlnPlot for consistency in patient ID assignments.

Summary by Sourcery

Update environment dependencies, add file existence checks with warnings in aggregation scripts, standardize grouping variables in R pipeline, and refresh citation metadata.

Enhancements:

  • Upgrade multiple package versions in the Ubuntu environment configuration
  • Add file existence checks and log warnings for missing files in RNA and ATAC aggregation scripts
  • Use HTO_maxID and HTO_classification for VlnPlot grouping and patient_id assignments in the R QC pipeline

Documentation:

  • Update CITATION.cff to reflect the new version and release date

@sourcery-ai

sourcery-ai Bot commented Jul 23, 2025

Copy link
Copy Markdown
Contributor

Reviewer's Guide

This PR updates environment dependency versions in the Ubuntu configuration, adds file existence checks with warnings in the cellranger aggregation scripts, refines grouping variables and patient ID assignments in QC R scripts to use HTO-based identifiers, and bumps the version and release date in the CITATION metadata.

Class diagram for updated grouping and patient ID assignment in QC R scripts

classDiagram
    class sc_total {
        library_id : string
        patient_id : string
        HTO_maxID : string
        HTO_classification : string
        # MULTI_ID : string (replaced)
        # MULTI_classification : string (replaced)
        sample_id : string
    }

    class VlnPlot {
        +plot(features, group.by, ...)
    }

    sc_total "1" -- "*" VlnPlot : used in

    %% Notes on changes:
    %% - group.by in VlnPlot now uses HTO_maxID and HTO_classification instead of MULTI_ID and MULTI_classification
    %% - patient_id assignment now uses HTO_maxID instead of MULTI_ID
    %% - MULTI_ID and MULTI_classification are replaced by HTO-based fields
Loading

Flow diagram for file existence checks in aggregation scripts

flowchart TD
    A[Start aggregation script] --> B{For each sample}
    B --> C[Determine file paths]
    C --> D{Do all required files exist?}
    D -- Yes --> E[Append sample info to AGGR_CSV]
    D -- No --> F[Log warning and skip sample]
    E --> G[Next sample]
    F --> G
    G --> B
    B --> H[End]
Loading

File-Level Changes

Change Details Files
Update Ubuntu environment package versions
  • Bumped system library revisions (e.g. binutils_impl, ld_impl, libsqlite, libwebp-base)
  • Upgraded Python and R packages (e.g. ca-certificates, certifi, pandas, narwhals, r/commonmark, r/cowplot, statsmodels, uv)
environment_ubuntu-latest.yml
Add file existence checks with warning logs in aggregation scripts
  • Wrap existing record writes in file-present conditionals
  • Emit warnings and skip entries when RNA/ATAC files are missing
src/aggr_template/pipeline/RNA.FB.VDJ/run_cellranger.aggr_rna.sh
src/aggr_template/pipeline/ATAC.ASAP/run_cellranger.aggr_atac.sh
Refine QC scripts to use HTO identifiers for grouping and patient IDs
  • Replace MULTI_ID/classification with HTO_maxID/classification in VlnPlot calls
  • Adjust patient_id assignment and filtering to reference HTO_maxID
src/phase2_scripts/LRA/run_phase2.QC_LRA_rna.R
Bump version and release date in CITATION metadata
  • Updated version number
  • Updated release date
CITATION.cff

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@willisbillis willisbillis merged commit b77149b into dev Jul 23, 2025
3 checks passed
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.

2 participants