broadinstitute / catch

A package for designing compact and comprehensive capture probe sets.
MIT License
76 stars 16 forks source link

Expand descriptions of LSH-relevant arguments in README and help messages #57

Closed haydenm closed 10 months ago

haydenm commented 10 months ago

This PR expands descriptions of arguments that use locality-sensitive hashing—to lower runtime and memory usage on especially large inputs—in the README and help messages. Namely, the PR:

codecov[bot] commented 10 months ago

Codecov Report

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

Comparison is base (895a7e3) 93.73% compared to head (d178bd4) 93.73%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #57 +/- ## ======================================= Coverage 93.73% 93.73% ======================================= Files 63 63 Lines 6115 6115 ======================================= Hits 5732 5732 Misses 383 383 ``` | [Flag](https://app.codecov.io/gh/broadinstitute/catch/pull/57/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=broadinstitute) | Coverage Δ | | |---|---|---| | [unittests](https://app.codecov.io/gh/broadinstitute/catch/pull/57/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=broadinstitute) | `93.73% <ø> (ø)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=broadinstitute#carryforward-flags-in-the-pull-request-comment) to find out more.

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