broadinstitute / adapt

A package for designing activity-informed nucleic acid diagnostics for viruses.
MIT License
27 stars 1 forks source link

Change default objective function to maximize-activity #70

Closed haydenm closed 1 year ago

haydenm commented 1 year ago

See #38.

Previously, the default objective function has been --obj minimize-guides. This made things easier because it does not require a predictive model. However, it is not what we generally use in practice nor what we use in our publication.

This commit changes the default to be --obj maximize-activity. If a predictive model is not set, design.py exits with a message to either set one or to use --use-simple-binary-activity-prediction, which resorts to using mismatches for binary predictions of activity.

This commit also updates the README accordingly.

codecov[bot] commented 1 year ago

Codecov Report

Base: 87.40% // Head: 87.40% // No change to project coverage :thumbsup:

Coverage data is based on head (396ad53) compared to base (484d78f). Patch has no changes to coverable lines.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #70 +/- ## ======================================= Coverage 87.40% 87.40% ======================================= Files 56 56 Lines 9796 9796 ======================================= Hits 8562 8562 Misses 1234 1234 ``` | [Impacted Files](https://codecov.io/gh/broadinstitute/adapt/pull/70?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=broadinstitute) | Coverage Δ | | |---|---|---| | [bin/design.py](https://codecov.io/gh/broadinstitute/adapt/pull/70/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=broadinstitute#diff-YmluL2Rlc2lnbi5weQ==) | `66.56% <ø> (ø)` | | Help us with your feedback. Take ten seconds to tell us [how you rate us](https://about.codecov.io/nps?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=broadinstitute). Have a feature suggestion? [Share it here.](https://app.codecov.io/gh/feedback/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=broadinstitute)

:umbrella: View full report at Codecov.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.