Skip to content
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.

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

fix naming of example data in doc examples #387

Merged
merged 1 commit into from
Oct 1, 2023
Merged
Changes from all commits
Commits
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
fix naming of example data in doc examples
  • Loading branch information
eroell committed Sep 30, 2023
commit 004dcc84f770f675499808e1dbe30fdb0450c307
12 changes: 6 additions & 6 deletions pertpy/tools/_distances/_distances.py
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ class Distance:

Examples:
>>> import pertpy as pt
>>> adata = pt.dt.distance_example_data()
>>> adata = pt.dt.distance_example()
>>> Distance = pt.tools.Distance(metric="edistance")
>>> X = adata.obsm["X_pca"][adata.obs["perturbation"] == "p-sgCREB1-2"]
>>> Y = adata.obsm["X_pca"][adata.obs["perturbation"] == "control"]
Expand Down Expand Up @@ -100,7 +100,7 @@ def __call__(

Examples:
>>> import pertpy as pt
>>> adata = pt.dt.distance_example_data()
>>> adata = pt.dt.distance_example()
>>> Distance = pt.tools.Distance(metric="edistance")
>>> X = adata.obsm["X_pca"][adata.obs["perturbation"] == "p-sgCREB1-2"]
>>> Y = adata.obsm["X_pca"][adata.obs["perturbation"] == "control"]
Expand Down Expand Up @@ -131,9 +131,9 @@ def pairwise(

Examples:
>>> import pertpy as pt
>>> adata = pt.dt.distance_example_data()
>>> adata = pt.dt.distance_example()
>>> Distance = pt.tools.Distance(metric="edistance")
>>> pairwise_df = distance.pairwise(adata, groupby="perturbation")
>>> pairwise_df = Distance.pairwise(adata, groupby="perturbation")
"""
groups = adata.obs[groupby].unique() if groups is None else groups
grouping = adata.obs[groupby].copy()
Expand Down Expand Up @@ -205,9 +205,9 @@ def onesided_distances(

Examples:
>>> import pertpy as pt
>>> adata = pt.dt.distance_example_data()
>>> adata = pt.dt.distance_example()
>>> Distance = pt.tools.Distance(metric="edistance")
>>> pairwise_df = distance.onesided_distances(adata, groupby="perturbation", selected_group="control")
>>> pairwise_df = Distance.onesided_distances(adata, groupby="perturbation", selected_group="control")
"""
groups = adata.obs[groupby].unique() if groups is None else groups
grouping = adata.obs[groupby].copy()
Expand Down
Loading