Skip to content

RNA-seq case study doc: mentions split_skip_reads=true is critical but example command doesn’t include it (and RNASEQ doesn’t auto-enable) #1061

@brianjohnhaas

Description

@brianjohnhaas

Link: https://github.com/google/deepvariant/blob/r1.10/docs/deepvariant-rnaseq-case-study.md

Problem
In the RNA-seq case study, the “Flag summary” section states that split_skip_reads=true is Important and “critical for RNA-seq variant calling to work properly”, but the example run_deepvariant command shown above does not include any --make_examples_extra_args to set it.

This is confusing because it implies the option must be provided, yet the provided command omits it.

What I expected
Either:

The example command should include something like --make_examples_extra_args="split_skip_reads=true,channels=''" (exact quoting as needed), or
The documentation should explain that --model_type=RNASEQ automatically enables it (if that’s true).
What I found in code (r1.10)
scripts/run_deepvariant.py does not appear to automatically set split_skip_reads when --model_type=RNASEQ is used (no references to split_skip_reads in that script; only passes through --make_examples_extra_args if the user supplies it).
The split_skip_reads flag default is False in deepvariant/realigner/realigner.py.
References:

run_deepvariant.py (no split_skip_reads handling):
https://github.com/google/deepvariant/search?q=repo%3Agoogle%2Fdeepvariant+path%3Ascripts%2Frun_deepvariant.py+split_skip_reads&type=code
split_skip_reads flag default False:
https://github.com/google/deepvariant/blob/r1.10/deepvariant/realigner/realigner.py
Proposed fix
Update docs/deepvariant-rnaseq-case-study.md so the example command and the “Flag summary” are consistent:

Add the missing --make_examples_extra_args=... to the command, or
Adjust wording to clarify when/how the flag is enabled.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions