Skip to content

Commit 91ac2e2

Browse files
docs: remove usage examples from phenotype method docstrings and register new methods in Ag3.rst
1 parent d53e326 commit 91ac2e2

2 files changed

Lines changed: 11 additions & 22 deletions

File tree

docs/source/Ag3.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -224,3 +224,14 @@ Inversion karyotypes
224224
:toctree: generated/
225225

226226
karyotype
227+
228+
Phenotype data access
229+
---------------------
230+
.. autosummary::
231+
:toctree: generated/
232+
233+
phenotype_data
234+
phenotypes_with_snps
235+
phenotypes_with_haplotypes
236+
phenotype_sample_sets
237+
phenotype_binary

malariagen_data/anoph/phenotypes.py

Lines changed: 0 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -344,28 +344,6 @@ def phenotype_data(
344344
-------
345345
pd.DataFrame
346346
DataFrame containing phenotype data merged with sample metadata.
347-
348-
Examples
349-
--------
350-
# Load all phenotype data
351-
df = ag3.phenotype_data(sample_sets=['1237-VO-BJ-DJOGBENOU-VMF00050'])
352-
353-
# Filter by insecticide
354-
df = ag3.phenotype_data(
355-
sample_sets=['1237-VO-BJ-DJOGBENOU-VMF00050'],
356-
sample_query="insecticide == 'Deltamethrin'"
357-
)
358-
359-
# Filter by multiple criteria
360-
df = ag3.phenotype_data(
361-
sample_sets=['1237-VO-BJ-DJOGBENOU-VMF00050'],
362-
sample_query="insecticide == 'Deltamethrin' and dose >= 1.0 and phenotype == 'alive'"
363-
)
364-
365-
# Filter by location and insecticide
366-
df = ag3.phenotype_data(
367-
sample_query="location == 'Cotonou' and insecticide in ['Deltamethrin', 'Bendiocarb']"
368-
)
369347
"""
370348
# 1. Normalize sample_sets
371349
sample_sets_norm = self._prep_sample_sets_param(sample_sets=sample_sets)

0 commit comments

Comments
 (0)