Skip to content

fix: allow multiple references in mehari server run #749

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

tedil
Copy link
Contributor

@tedil tedil commented Apr 24, 2025

Support multiple references in mehari server run, e.g.

mehari server run \
  --transcripts GRCh38-ensembl.bin.zst \
  --transcripts GRCh37-ensembl.bin.zst \
  --reference GCF_000001405.40_GRCh38.p14_genomic.fna \
  --reference GCF_000001405.25_GRCh37.p13_genomic.fna

Note that this relies on the strings "GRCh38" or "GRCh37" to be present in the file path (the check is done on lowercase strings) at the moment, i.e. there is no sophisticated logic for matching the --transcripts to the --reference (and also no cli based matching, e.g. something along the lines of --transcripts GRCh38=foo.bin.zst --transcripts GRCH37=bar.bin.zst --reference GRCh38=baz.fasta --reference GRCh37=etc).

Resolves #716

Summary by CodeRabbit

  • New Features

    • Added support for specifying multiple reference genome files.
    • Improved informational logging to display loaded data sources and predictor build status.
  • Bug Fixes

    • Enhanced validation to ensure the number of reference genomes matches supported genome releases, providing clearer error messages.
  • Documentation

    • Clarified requirements for reference genome file names in user-facing documentation.

Copy link
Contributor

coderabbitai bot commented Apr 24, 2025

Walkthrough

The changes update the handling of reference genome paths in the server's run module. The Args struct's reference field now accepts multiple paths instead of a single optional path, with added documentation specifying that paths must contain "GRCh37" or "GRCh38" for correct matching. The run function validates that the number of provided references matches supported genome releases or is zero, and matches each reference to its genome release by filename. Logging improvements and warnings are included for unmatched references, and the annotator construction now uses the matched reference path per genome release.

Changes

File(s) Change Summary
src/server/run/mod.rs Changed Args.reference from Option<PathBuf> to Vec<PathBuf>, updated documentation, implemented logic for matching multiple reference genome paths to genome releases, added validation, improved logging, and updated annotator construction to use per-release reference paths.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Server
    participant Annotator

    User->>Server: Start with Args (multiple reference paths)
    Server->>Server: Validate reference count vs genome releases
    Server->>Server: For each genome release, match reference path by name
    Server->>Annotator: Build ConsequenceAnnotator with matched reference path
    Server->>Server: Log loaded sources
    Server-->>User: Complete setup or return error
Loading

Possibly related PRs

  • feat: allow specifying reference FASTA #684: Adds support for specifying a single reference FASTA and in-memory loading, including changes to annotator construction and reference genome handling, directly related to the new multi-reference input logic.

Poem

A rabbit hopped through code so bright,
Matching genomes left and right—
With many paths now in its pack,
It finds the right one, never looks back.
Logs are clearer, warnings sound,
Genome releases all around!
🐇✨

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (2)
src/server/run/mod.rs (2)

264-288: Consider a more robust mechanism for matching references to genome releases

The current implementation uses substring matching on filenames, which could lead to incorrect matches if filenames contain both "GRCh37" and "GRCh38". Additionally, if multiple references match the same genome release, only the first match is used.

A more robust approach might be to:

  1. Use a more explicit mapping syntax in the CLI, e.g., --reference GRCh38=path/to/reference.fna
  2. Or implement a fallback pattern-matching approach with stricter rules
let reference = {
    args.reference
        .iter()
        .filter_map(|reference_path| {
+           // First try for exact matches in format like "GRCh38.fna" or "GRCh38_reference.fna"
+           let filename = reference_path.file_name().map(|f| f.to_string_lossy().to_lowercase());
+           let matches_pattern = filename.as_ref().map_or(false, |name| {
+               name == genome_release.name().to_lowercase() || 
+               name.starts_with(&format!("{}.", genome_release.name().to_lowercase())) ||
+               name.starts_with(&format!("{}_", genome_release.name().to_lowercase()))
+           });
+           
+           if matches_pattern {
+               tracing::info!(
+                   "Found reference genome for {:?}: {}",
+                   genome_release,
+                   reference_path.display()
+               );
+               return Some(reference_path.clone());
+           }
+           
            // Fall back to substring matching
            if reference_path
                .file_name()
                .map(|f| {
                    f.to_string_lossy()
                        .to_lowercase()
                        .contains(&genome_release.name().to_lowercase())
                })
                .unwrap_or(false)
            {
                tracing::info!(
                    "Found reference genome for {:?}: {}",
                    genome_release,
                    reference_path.display()
                );
                Some(reference_path.clone())
            } else {
                None
            }
        })
        .next()
};

294-323: Consider adding a check for ambiguous reference matches

The current implementation doesn't warn users if a reference file might match multiple genome releases.

Before this section, you could add code to check if any reference matches multiple genome releases and log a warning:

// Check for ambiguous reference matches
let mut ambiguous_refs = Vec::new();
for ref_path in &args.reference {
    let matches = GenomeRelease::value_variants()
        .iter()
        .filter(|gr| {
            ref_path
                .file_name()
                .map(|f| {
                    f.to_string_lossy()
                        .to_lowercase()
                        .contains(&gr.name().to_lowercase())
                })
                .unwrap_or(false)
        })
        .count();
    
    if matches > 1 {
        ambiguous_refs.push(ref_path);
    }
}

if !ambiguous_refs.is_empty() {
    tracing::warn!(
        "The following reference paths match multiple genome releases and may be ambiguous: {:?}",
        ambiguous_refs
    );
}
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5d50862 and cf40972.

📒 Files selected for processing (1)
  • src/server/run/mod.rs (6 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (1)
src/server/run/mod.rs (3)
src/common/mod.rs (1)
  • new (151-156)
src/annotate/seqvars/mod.rs (4)
  • new (1390-1392)
  • new (1677-1679)
  • new (1822-1824)
  • new (1886-1888)
src/annotate/strucvars/csq.rs (1)
  • new (453-460)
⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: Schema
  • GitHub Check: Testing
  • GitHub Check: Linting
  • GitHub Check: build-and-push-image
🔇 Additional comments (4)
src/server/run/mod.rs (4)

120-125: Clear and helpful documentation for the multiple reference paths.

The updated documentation helpfully explains that reference paths must contain "GRCh37" or "GRCh38" for correct matching, which is crucial information for users.


290-292: Good warning message for unmatched references

This warning is helpful to users when they provide references but none match a particular genome release.


379-380: Helpful log message for loaded sources

Adding this log message helps users understand which sources were successfully loaded.


256-259: 🛠️ Refactor suggestion

Consider allowing partial specification of references

The current implementation requires either zero references or exactly the number of supported genome releases (currently 2 - GRCh37 and GRCh38). This prevents users from specifying a reference for just one genome release, which might be a common use case.

-if !(0..=GenomeRelease::value_variants().len()).contains(&args.reference.len()) {
-    return Err(anyhow!("Supplied number of reference genomes does not match the number of supported genome releases ({:?}).",
-    GenomeRelease::value_variants()));
-}

You could remove this validation entirely and rely on the warnings when references are provided but none match a particular genome release (lines 290-292).

Likely an incorrect or invalid review comment.

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.

Usage question, mehari server run and multiple references
1 participant