fix: allow multiple references in mehari server run
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.
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
Possibly related PRs
- varfish-org/mehari#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.
🪧 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
@coderabbitaiin 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
@coderabbitaiin 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 pauseto pause the reviews on a PR.@coderabbitai resumeto resume the paused reviews.@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository.@coderabbitai full reviewto do a full review from scratch and review all the files again.@coderabbitai summaryto regenerate the summary of the PR.@coderabbitai generate docstringsto generate docstrings for this PR.@coderabbitai generate sequence diagramto generate a sequence diagram of the changes in this PR.@coderabbitai resolveresolve all the CodeRabbit review comments.@coderabbitai configurationto show the current CodeRabbit configuration for the repository.@coderabbitai helpto get help.
Other keywords and placeholders
- Add
@coderabbitai ignoreanywhere in the PR description to prevent this PR from being reviewed. - Add
@coderabbitai summaryto generate the high-level summary at a specific location in the PR description. - Add
@coderabbitaianywhere in the PR title to generate the title automatically.
CodeRabbit Configuration File (.coderabbit.yaml)
- You can programmatically configure CodeRabbit by adding a
.coderabbit.yamlfile 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.