Skip to content

docs: specify sc.tl.score_genes array type support #3989

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
flying-sheep merged 2 commits into from
Feb 26, 2026
+7 −1
Merged

docs: specify sc.tl.score_genes array type support #3989

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d2deaab
docs: document sc.tl.score_genes array-type
flying-sheep Feb 26, 2026
5a4c972
oops
flying-sheep Feb 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/api/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@ Additional functionality is available in the broader {doc}`ecosystem <../ecosyst
## Array type support

Different APIs have different levels of support for array types,
and this page lists the supported array types for each function:
and this page lists the supported array types for each function
(⚡ indicates support of the type as chunk in a dask {class}`~dask.array.Array`):

```{eval-rst}
.. array-support:: all
Expand Down
1 change: 1 addition & 0 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,6 +196,7 @@
"tl.louvain": (["np", "sp"], []), # only uses graph in obsp
"tl.paga": (["np", "sp"], []),
"tl.rank_genes_groups": (["np", "sp"], []),
"tl.score_genes": (["np", "sp"], []),
"tl.tsne": (["np", "sp"], []),
"tl.umap": (["np", "sp"], []),
}
Expand Down
4 changes: 4 additions & 0 deletions src/scanpy/tools/_score_genes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,8 @@ def score_genes( # noqa: PLR0913
programs and cell scores" in materials and methods) and has been implemented
for Scanpy by Davide Cittaro.

.. array-support:: tl.score_genes

Parameters
----------
adata
Expand Down Expand Up @@ -269,6 +271,8 @@ def score_genes_cell_cycle(
scores and assigns a cell cycle phase (G1, S or G2M). See
:func:`~scanpy.tl.score_genes` for more explanation.

.. array-support:: tl.score_genes

Parameters
----------
adata
Expand Down
Loading