search

fulcrumgenomics / prymer

Python Primer Design Library
https://prymer.readthedocs.io/en/latest/
MIT License
8 stars 0 forks source link

feat: Add support for `min_primer_pair_hits` to `OffTargetDetector` #44

Closed msto closed 2 weeks ago

msto commented 2 weeks ago

Closes #43

This PR introduces a new parameter to OffTargetDetector, min_primer_pair_hits. This permits the user to relax the current constraint that every primer pair have at least one hit in the reference.

I have set the default value to 1, so default behavior remains unchanged by this PR, and documented the use case where it may be appropriate to change this value.

msto commented 2 weeks ago

Per slack discussion and approval from @emmcauley and @ameynert, we are choosing min_.

I added a brief note to the docstring to indicate that the min is typically the number of amplicons a primer pair is expected to generate.

codecov[bot] commented 2 weeks ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 97.37%. Comparing base (70f6840) to head (4d20ec3). Report is 1 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #44 +/- ## ======================================= Coverage 97.37% 97.37% ======================================= Files 25 25 Lines 1597 1598 +1 Branches 302 302 ======================================= + Hits 1555 1556 +1 Misses 23 23 Partials 19 19 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.