Skip to content

Commit 00722e6

Browse files
committed
Add a minimal Quick Start example to the README
1 parent 4e90185 commit 00722e6

1 file changed

Lines changed: 16 additions & 0 deletions

File tree

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,22 @@ package index (PyPI) and can be installed via `pip`, e.g.:
1010
```bash
1111
pip install malariagen-data
1212
```
13+
## Quick Start
14+
15+
Once installed, you can begin accessing MalariaGEN datasets directly
16+
from Python.
17+
18+
For example, to work with the Pf8 dataset:
19+
20+
```python
21+
import malariagen_data
22+
23+
# Instantiate dataset
24+
pf8 = malariagen_data.Pf8()
25+
26+
# Load sample metadata
27+
df = pf8.sample_metadata()
28+
print(df.head())
1329

1430
## Documentation
1531

0 commit comments

Comments
 (0)