Updated Harmony Integrate Docs to better match interface to Harmonypy package #3362
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
Fixed harmony documentation where a crucial feature of Harmony, namely the integration w.r.t. multiple covariates was not mentioned despite being supported by the interface. Harmony can take strings and lsits of strings as its "vars_sue" parameter which is named "key" in the Scanpy interface
Added required improt fo sequence type
Included # noqa: TCH003 comment like other imports of Mapping module do in scanpys source code
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #3362 +/- ##
=======================================
Coverage 76.49% 76.49%
=======================================
Files 111 111
Lines 12866 12867 +1
=======================================
+ Hits 9842 9843 +1
Misses 3024 3024
|
|
Thanks! |
meeseeksmachine
pushed a commit
to meeseeksmachine/scanpy
that referenced
this pull request
Nov 19, 2024
…tch interface to Harmonypy package
flying-sheep
pushed a commit
that referenced
this pull request
Nov 19, 2024
… better match interface to Harmonypy package) (#3376) Co-authored-by: Damin Kühn <[email protected]>
flying-sheep
added a commit
that referenced
this pull request
Nov 21, 2024
… package (#3362) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Phil Schaf <[email protected]>
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.
Fixed harmony documentation where a crucial feature of Harmony, namely the integration w.r.t. multiple covariates was not mentioned despite being supported by the interface. Harmony can take strings and lists of strings as its "vars_use" parameter which is named "key" in the Scanpy interface.
Small non-breaking change to docs. However, pre-commit throws:
Will wait if some maintainer know an easy fix for this before trying to debug this myself. Guess its more related to incorrect flags somewhere than the code.
Change docs to better reflect current code behaviour/features