Skip to content

Commit 86db19f

Browse files
committed
docs: coderabbit suggestions, mkdocs error
1 parent e2d71aa commit 86db19f

File tree

2 files changed

+6
-9
lines changed

2 files changed

+6
-9
lines changed

prymer/api/variant_lookup.py

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
"""
22
# Variant Lookup Class and Methods
33
4-
This module contains the abstract class
5-
[`VariantLookup`][prymer.api.variant_lookup.VariantLookup] to facilitate retrieval of
6-
variants that overlap a given genomic coordinate range. Concrete implementations must implement the
7-
[`query()`][prymer.api.variant_lookup.VariantLookup.query] method for retrieving variants
4+
This module contains the class [`VariantLookup`][prymer.api.variant_lookup.VariantLookup] to
5+
facilitate retrieval of variants that overlap a given genomic coordinate range.
6+
The [`query()`][`prymer.api.variant_lookup.VariantLookup.query`] method is used to retrieve variants
87
that overlap the given range.
98
109
[`VariantLookup`][prymer.api.variant_lookup.VariantLookup] needs a list of VCF files to be queried,
@@ -345,7 +344,6 @@ def query(
345344
maf: Optional[float] = None,
346345
include_missing_mafs: bool = None,
347346
) -> list[SimpleVariant]:
348-
349347
maf = maf if maf is not None else self.min_maf
350348
include_missing_mafs = (
351349
include_missing_mafs if include_missing_mafs is not None else self.include_missing_mafs

tests/api/test_variant_lookup.py

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@
1919
from prymer.api.variant_lookup import VariantType
2020
from prymer.api.variant_lookup import _DiskBasedLookup
2121
from prymer.api.variant_lookup import _InMemoryLookup
22-
from prymer.api.variant_lookup import _VariantLookup
2322
from prymer.api.variant_lookup import calc_maf_from_filter
2423

2524

@@ -380,7 +379,7 @@ def get_simple_variant_approx_by_id(*variant_id: str) -> list[SimpleVariant]:
380379

381380

382381
def variant_overlap_detector_query(
383-
detector: VariantLookup | _VariantLookup,
382+
detector: VariantLookup,
384383
refname: str,
385384
start: int,
386385
end: int,
@@ -537,8 +536,8 @@ def test_calc_maf_from_gt_only() -> None:
537536

538537
def test_variant_overlap_detector_query(vcf_path: Path) -> None:
539538
"""Test `VariantOverlapDetector.query()` positional filtering."""
540-
variant_overlap_detector = _InMemoryLookup(
541-
vcf_paths=[vcf_path], min_maf=0.0, include_missing_mafs=True
539+
variant_overlap_detector = VariantLookup(
540+
vcf_paths=[vcf_path], min_maf=0.0, include_missing_mafs=True, cached=True
542541
)
543542

544543
# query for all variants

0 commit comments

Comments
 (0)