Skip to content

Commit 5ea6f40

Browse files
committed
fix(tests): resolve merge conflict in test_base.py
2 parents f83d7a1 + 772c135 commit 5ea6f40

14 files changed

Lines changed: 377 additions & 72 deletions

File tree

LINUX_SETUP.md

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# Developer setup (Linux)
2+
3+
To get setup for development, see [this video if you prefer VS Code](https://youtu.be/zddl3n1DCFM), or [this older video if you prefer PyCharm](https://youtu.be/QniQi-Hoo9A), and the instructions below.
4+
5+
## 1. Fork and clone this repo
6+
```bash
7+
git clone git@github.com:[username]/malariagen-data-python.git
8+
cd malariagen-data-python
9+
```
10+
11+
## 2. Install Python
12+
```bash
13+
sudo add-apt-repository ppa:deadsnakes/ppa
14+
sudo apt install python3.10 python3.10-venv
15+
```
16+
17+
## 3. Install pipx and poetry
18+
```bash
19+
python3.10 -m pip install --user pipx
20+
python3.10 -m pipx ensurepath
21+
pipx install poetry
22+
```
23+
24+
## 4. Create and activate development environment
25+
```bash
26+
poetry install
27+
poetry shell
28+
```
29+
30+
## 5. Install pre-commit hooks
31+
```bash
32+
pipx install pre-commit
33+
pre-commit install
34+
```
35+
36+
Run pre-commit checks manually:
37+
```bash
38+
pre-commit run --all-files
39+
```
40+
41+
## 6. Run tests
42+
43+
Run fast unit tests using simulated data:
44+
```bash
45+
poetry run pytest -v tests/anoph
46+
```
47+
48+
## 7. Google Cloud authentication (for legacy tests)
49+
50+
To run legacy tests which read data from GCS, you'll need to [request access to MalariaGEN data on GCS](https://malariagen.github.io/vector-data/vobs/vobs-data-access.html).
51+
52+
Once access has been granted, [install the Google Cloud CLI](https://cloud.google.com/sdk/docs/install):
53+
```bash
54+
./install_gcloud.sh
55+
```
56+
57+
Then obtain application-default credentials:
58+
```bash
59+
./google-cloud-sdk/bin/gcloud auth application-default login
60+
```
61+
62+
Once authenticated, run legacy tests:
63+
```bash
64+
poetry run pytest --ignore=tests/anoph -v tests
65+
```
66+
67+
Tests will run slowly the first time, as data will be read from GCS and cached locally in the `gcs_cache` folder.

MACOS_SETUP.md

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
# Developer setup (macOS)
2+
3+
The Linux setup guide is available in [LINUX_SETUP.md](LINUX_SETUP.md). If you are on macOS, follow these steps instead.
4+
5+
## 1. Install Miniconda
6+
7+
Download and install Miniconda for macOS from https://docs.conda.io/en/latest/miniconda.html.
8+
Choose the Apple Silicon installer if you have an Apple Silicon Mac, or the Intel installer otherwise. You can check with:
9+
```bash
10+
uname -m
11+
# arm64 = Apple Silicon, x86_64 = Intel
12+
```
13+
14+
After installation, close and reopen your terminal for conda to be available.
15+
16+
## 2. Create a conda environment
17+
18+
The package requires Python `>=3.10, <3.13`. Python 3.13+ is not currently supported.
19+
```bash
20+
conda create -n malariagen python=3.11
21+
conda activate malariagen
22+
```
23+
24+
## 3. Fork and clone this repo
25+
26+
Fork the repository on GitHub, then clone your fork:
27+
```bash
28+
git clone git@github.com:[username]/malariagen-data-python.git
29+
cd malariagen-data-python
30+
pip install -e ".[dev]"
31+
```
32+
33+
## 4. Install pre-commit hooks
34+
```bash
35+
pre-commit install
36+
```
37+
38+
Run pre-commit checks manually:
39+
```bash
40+
pre-commit run --all-files
41+
```
42+
43+
## 5. Run tests
44+
45+
Run fast unit tests using simulated data:
46+
```bash
47+
pytest -v tests/anoph
48+
```
49+
50+
## 6. Google Cloud authentication (for legacy tests)
51+
52+
To run legacy tests which read data from GCS, you'll need to [request access to MalariaGEN data on GCS](https://malariagen.github.io/vector-data/vobs/vobs-data-access.html).
53+
54+
Once access has been granted, install the Google Cloud CLI:
55+
```bash
56+
brew install google-cloud-sdk
57+
```
58+
59+
Then authenticate:
60+
```bash
61+
gcloud auth application-default login
62+
```
63+
64+
This opens a browser — log in with any Google account.
65+
66+
Once authenticated, run legacy tests:
67+
```bash
68+
pytest --ignore=tests/anoph -v tests
69+
```
70+
71+
Tests will run slowly the first time, as data will be read from GCS and cached locally in the `gcs_cache` folder.
72+
73+
## 7. VS Code terminal integration
74+
75+
To use the `code` command from the terminal:
76+
77+
Open VS Code → `Cmd + Shift + P` → type `Shell Command: Install 'code' command in PATH` → press Enter.

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,11 @@ for release notes.
4444

4545
## Developer setup
4646

47-
To get setup for development, see [this video if you prefer VS Code](https://youtu.be/zddl3n1DCFM), or [this older video if you prefer PyCharm](https://youtu.be/QniQi-Hoo9A), and the instructions below.
47+
To get setup for development, see [this video if you prefer VS Code](https://youtu.be/zddl3n1DCFM), or [this older video if you prefer PyCharm](https://youtu.be/QniQi-Hoo9A).
4848

49+
For detailed setup instructions, see:
50+
- [Linux setup guide](LINUX_SETUP.md)
51+
- [macOS setup guide](MACOS_SETUP.md)
4952
Detailed instructions can be found in the [Contributors guide](https://github.com/malariagen/malariagen-data-python/blob/master/CONTRIBUTING.md).
5053

5154
## AI use policy and guidelines

docs/source/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ Some data from MalariaGEN are subject to **terms of use** which may include an e
9292
public communication of any analysis results without permission from data owners. If you
9393
have any questions about terms of use please email support@malariagen.net.
9494

95-
By default, this sofware package accesses data directly from the **MalariaGEN cloud data repository**
95+
By default, this software package accesses data directly from the **MalariaGEN cloud data repository**
9696
hosted in Google Cloud Storage in the US. Note that data access will be more efficient if your
9797
computations are also run within the same region. Google Colab provides a convenient and free
9898
service which you can use to explore data and run computations. If you have any questions about

malariagen_data/anoph/distance.py

Lines changed: 37 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -365,24 +365,43 @@ def _njt(
365365
from scipy.spatial.distance import squareform # type: ignore
366366

367367
# Compute pairwise distances.
368-
dist, samples, n_snps = self.biallelic_diplotype_pairwise_distances(
369-
region=region,
370-
n_snps=n_snps,
371-
metric=metric,
372-
sample_sets=sample_sets,
373-
sample_indices=sample_indices,
374-
site_mask=site_mask,
375-
site_class=site_class,
376-
inline_array=inline_array,
377-
chunks=chunks,
378-
cohort_size=cohort_size,
379-
min_cohort_size=min_cohort_size,
380-
max_cohort_size=max_cohort_size,
381-
random_seed=random_seed,
382-
max_missing_an=max_missing_an,
383-
min_minor_ac=min_minor_ac,
384-
thin_offset=thin_offset,
385-
)
368+
try:
369+
dist, samples, n_snps_used = self.biallelic_diplotype_pairwise_distances(
370+
region=region,
371+
n_snps=n_snps,
372+
metric=metric,
373+
sample_sets=sample_sets,
374+
sample_indices=sample_indices,
375+
site_mask=site_mask,
376+
site_class=site_class,
377+
inline_array=inline_array,
378+
chunks=chunks,
379+
cohort_size=cohort_size,
380+
min_cohort_size=min_cohort_size,
381+
max_cohort_size=max_cohort_size,
382+
random_seed=random_seed,
383+
max_missing_an=max_missing_an,
384+
min_minor_ac=min_minor_ac,
385+
thin_offset=thin_offset,
386+
)
387+
388+
except ValueError as e:
389+
raise ValueError(
390+
f"Unable to construct neighbour-joining tree. {e} "
391+
f"This could be because the selected region does not "
392+
f"contain enough polymorphic SNPs for the given sample "
393+
f"sets and query parameters."
394+
) from e
395+
396+
# Validate enough samples for a tree.
397+
n_samples = len(samples)
398+
if n_samples < 3:
399+
raise ValueError(
400+
f"Not enough samples to construct a neighbour-joining tree. "
401+
f"A minimum of 3 samples is required, but only {n_samples} "
402+
f"were found for the given region and sample sets."
403+
)
404+
386405
D = squareform(dist)
387406

388407
# anjl supports passing in a progress bar function to get progress on the

malariagen_data/anoph/frq_base.py

Lines changed: 70 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -396,39 +396,50 @@ def plot_frequencies_time_series(
396396
# Extract variant labels.
397397
variant_labels = ds["variant_label"].values
398398

399+
# Check if CI variables are available.
400+
has_ci = "event_frequency_ci_low" in ds
401+
399402
# Build a long-form dataframe from the dataset.
400403
dfs = []
401404
for cohort in df_cohorts.itertuples():
402405
ds_cohort = ds.isel(cohorts=cohort.Index)
403-
df = pd.DataFrame(
404-
{
405-
"taxon": cohort.taxon,
406-
"area": cohort.area,
407-
"date": cohort.period_start,
408-
"period": str(
409-
cohort.period
410-
), # use string representation for hover label
411-
"sample_size": cohort.size,
412-
"variant": variant_labels,
413-
"count": ds_cohort["event_count"].values,
414-
"nobs": ds_cohort["event_nobs"].values,
415-
"frequency": ds_cohort["event_frequency"].values,
416-
"frequency_ci_low": ds_cohort["event_frequency_ci_low"].values,
417-
"frequency_ci_upp": ds_cohort["event_frequency_ci_upp"].values,
418-
}
419-
)
406+
cohort_data = {
407+
"taxon": cohort.taxon,
408+
"area": cohort.area,
409+
"date": cohort.period_start,
410+
"period": str(
411+
cohort.period
412+
), # use string representation for hover label
413+
"sample_size": cohort.size,
414+
"variant": variant_labels,
415+
"count": ds_cohort["event_count"].values,
416+
"nobs": ds_cohort["event_nobs"].values,
417+
"frequency": ds_cohort["event_frequency"].values,
418+
}
419+
if has_ci:
420+
cohort_data["frequency_ci_low"] = ds_cohort[
421+
"event_frequency_ci_low"
422+
].values
423+
cohort_data["frequency_ci_upp"] = ds_cohort[
424+
"event_frequency_ci_upp"
425+
].values
426+
df = pd.DataFrame(cohort_data)
420427
dfs.append(df)
421428
df_events = pd.concat(dfs, axis=0).reset_index(drop=True)
422429

423430
# Remove events with no observations.
424431
df_events = df_events.query("nobs > 0").copy()
425432

426-
# Calculate error bars.
427-
frq = df_events["frequency"]
428-
frq_ci_low = df_events["frequency_ci_low"]
429-
frq_ci_upp = df_events["frequency_ci_upp"]
430-
df_events["frequency_error"] = frq_ci_upp - frq
431-
df_events["frequency_error_minus"] = frq - frq_ci_low
433+
# Calculate error bars if CI data is available.
434+
error_y_args = {}
435+
if has_ci:
436+
frq = df_events["frequency"]
437+
frq_ci_low = df_events["frequency_ci_low"]
438+
frq_ci_upp = df_events["frequency_ci_upp"]
439+
df_events["frequency_error"] = frq_ci_upp - frq
440+
df_events["frequency_error_minus"] = frq - frq_ci_low
441+
error_y_args["error_y"] = "frequency_error"
442+
error_y_args["error_y_minus"] = "frequency_error_minus"
432443

433444
# Make a plot.
434445
fig = px.line(
@@ -437,8 +448,7 @@ def plot_frequencies_time_series(
437448
facet_row="area",
438449
x="date",
439450
y="frequency",
440-
error_y="frequency_error",
441-
error_y_minus="frequency_error_minus",
451+
**error_y_args,
442452
color="variant",
443453
markers=True,
444454
hover_name="variant",
@@ -518,19 +528,19 @@ def plot_frequencies_map_markers(
518528
variant_label = variant
519529

520530
# Convert to a dataframe for convenience.
521-
df_markers = ds_variant[
522-
[
523-
"cohort_taxon",
524-
"cohort_area",
525-
"cohort_period",
526-
"cohort_lat_mean",
527-
"cohort_lon_mean",
528-
"cohort_size",
529-
"event_frequency",
530-
"event_frequency_ci_low",
531-
"event_frequency_ci_upp",
532-
]
533-
].to_dataframe()
531+
cols = [
532+
"cohort_taxon",
533+
"cohort_area",
534+
"cohort_period",
535+
"cohort_lat_mean",
536+
"cohort_lon_mean",
537+
"cohort_size",
538+
"event_frequency",
539+
]
540+
has_ci = "event_frequency_ci_low" in ds
541+
if has_ci:
542+
cols += ["event_frequency_ci_low", "event_frequency_ci_upp"]
543+
df_markers = ds_variant[cols].to_dataframe()
534544

535545
# Select data matching taxon and period parameters.
536546
df_markers = df_markers.loc[
@@ -560,8 +570,11 @@ def plot_frequencies_map_markers(
560570
Area: {x.cohort_area} <br/>
561571
Period: {x.cohort_period} <br/>
562572
Sample size: {x.cohort_size} <br/>
563-
Frequency: {x.event_frequency:.0%}
564-
(95% CI: {x.event_frequency_ci_low:.0%} - {x.event_frequency_ci_upp:.0%})
573+
Frequency: {x.event_frequency:.0%}"""
574+
if has_ci:
575+
popup_html += f"""
576+
(95% CI: {x.event_frequency_ci_low:.0%} - {x.event_frequency_ci_upp:.0%})"""
577+
popup_html += """
565578
"""
566579
marker.popup = ipyleaflet.Popup(
567580
child=ipywidgets.HTML(popup_html),
@@ -609,13 +622,27 @@ def plot_frequencies_interactive_map(
609622
variants = ds["variant_label"].values
610623
taxa = ds["cohort_taxon"].to_pandas().dropna().unique() # type: ignore
611624
periods = ds["cohort_period"].to_pandas().dropna().unique() # type: ignore
625+
626+
if len(variants) == 0:
627+
raise ValueError("No variants available in dataset.")
628+
if len(taxa) == 0:
629+
raise ValueError("No taxons available in dataset.")
630+
if len(periods) == 0:
631+
raise ValueError("No periods available in dataset.")
632+
612633
controls = ipywidgets.interactive(
613634
self.plot_frequencies_map_markers,
614635
m=ipywidgets.fixed(freq_map),
615636
ds=ipywidgets.fixed(ds),
616-
variant=ipywidgets.Dropdown(options=variants, description="Variant: "),
617-
taxon=ipywidgets.Dropdown(options=taxa, description="Taxon: "),
618-
period=ipywidgets.Dropdown(options=periods, description="Period: "),
637+
variant=ipywidgets.Dropdown(
638+
options=variants, value=variants[0], description="Variant: "
639+
),
640+
taxon=ipywidgets.Dropdown(
641+
options=taxa, value=taxa[0], description="Taxon: "
642+
),
643+
period=ipywidgets.Dropdown(
644+
options=periods, value=periods[0], description="Period: "
645+
),
619646
clear=ipywidgets.fixed(True),
620647
)
621648

0 commit comments

Comments
 (0)