Skip to content

Commit ccba5e3

Browse files
authored
Clean up PCA docstring by removing old content
Removed deprecated parameters and examples from PCA documentation.
1 parent ef22fbb commit ccba5e3

1 file changed

Lines changed: 2 additions & 24 deletions

File tree

malariagen_data/anoph/pca.py

Lines changed: 2 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -41,30 +41,8 @@ def __init__(
4141
4242
The following additional parameters were also added in version 8.0.0:
4343
`site_class`, `cohort_size`, `min_cohort_size`, `max_cohort_size`,
44-
`random_seed`.
45-
46-
.. versionchanged:: 9.0.0
47-
The `cohorts` parameter has been added to enable cohort-based
48-
downsampling via the `max_cohort_size` parameter.
49-
""",
50-
returns=("df_pca", "evr"),
51-
notes="""
52-
This computation may take some time to run, depending on your computing
53-
environment. Results of this computation will be cached and re-used if
54-
the `results_cache` parameter was set when instantiating the API client.
55-
""",
56-
examples="""
57-
Run a PCA, downsampling to a maximum of 20 samples per country::
58-
59-
>>> import malariagen_data
60-
>>> ag3 = malariagen_data.Ag3()
61-
>>> df_pca, evr = ag3.pca(
62-
... region="3R",
63-
... n_snps=1000,
64-
... cohorts="country",
65-
... max_cohort_size=20,
66-
... )
67-
""",
44+
`random_seed`.,
45+
returns=("df_pca", "evr")
6846
)
6947
def pca(
7048
self,

0 commit comments

Comments
 (0)