Simplify divergence usage by making cov optional #44
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Previously, invoking the divergence function (and any functions that invoke the divergence function, like snapshot) required the P3 and coverage information to be stored in separate tables and connected by a key. This setup is convenient for data drawn from a database that uses this representation already, but is inconvenient for users reading in data that directly associates a coverage string with each performance result. This commit makes the cov DataFrame optional: if it exists, then behavior is the same as before; if it does not exist, then the library looks for coverage information stored alongside the P3 data. Signed-off-by: John Pennycook <[email protected]>
Pennycook
added
documentation
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Previously, invoking the divergence function (and any functions that invoke the divergence function, like snapshot) required the P3 and coverage information to be stored in separate tables and connected by a key.
This setup is convenient for data drawn from a database that uses this representation already, but is inconvenient for users reading in data that directly associates a coverage string with each performance result.
This commit makes the cov DataFrame optional: if it exists, then behavior is the same as before; if it does not exist, then the library looks for coverage information stored alongside the P3 data.
Related issues
N/A
Proposed changes
covoptional when callingdivergence.covoptional when callingsnapshot(which callsdivergenceinternally).