Skip to content

Commit

Permalink
changing scanpy.tl.pca to sc.tl.pca to get build docs to work
Browse files Browse the repository at this point in the history
  • Loading branch information
grantn5 committed Jun 12, 2024
1 parent 45d41be commit 8dd606a
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 5 deletions.
1 change: 0 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,6 @@
# Add any Sphinx extension module names here, as strings.
# They can be extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = [
"scanpy",
"myst_nb",
"sphinx_copybutton",
"sphinx.ext.autodoc",
Expand Down
8 changes: 4 additions & 4 deletions src/infercnvpy/tl/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,24 +41,24 @@ def pca(
) -> Union[np.ndarray, None]:
"""Compute the PCA on the result of :func:`infercnvpy.tl.infercnv`.
Thin wrapper around :func:`scanpy.tl.pca`.
Thin wrapper around :func:`sc.tl.pca`.
Parameters
----------
adata
annotated data matrix
svd_solver
See :func:`scanpy.tl.pca`.
See :func:`sc.tl.pca`.
zero_center
See :func:`scanpy.tl.pca`.
See :func:`sc.tl.pca`.
inplace
If True, store the result in adata.obsm. Otherwise return the PCA matrix.
use_rep
Key under which the result of infercnv is stored in adata
key_added
Key under which the result will be stored in adata.obsm if `inplace=True`.
**kwargs
Additional arguments passed to :func:`scanpy.tl.pca`.
Additional arguments passed to :func:`sc.tl.pca`.
"""
if f"X_{use_rep}" not in adata.obsm:
raise KeyError(f"X_{use_rep} is not in adata.obsm. Did you run `tl.infercnv`?")
Expand Down

0 comments on commit 8dd606a

Please sign in to comment.