Skip to content

Commit 09bee69

Browse files
committed
fix: restore docstrings in plasmodium.py that were accidentally removed
1 parent 8c79060 commit 09bee69

1 file changed

Lines changed: 24 additions & 0 deletions

File tree

malariagen_data/plasmodium.py

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,13 +51,29 @@ def _load_config(self, data_config):
5151
return config_content
5252

5353
def sample_metadata(self):
54+
"""Access sample metadata and return as pandas dataframe.
55+
Returns
56+
-------
57+
df : pandas.DataFrame
58+
A dataframe of sample metadata on the samples that were sequenced as part of this resource.
59+
Includes the time and place of collection, quality metrics, and accesion numbers.
60+
One row per sample.
61+
"""
5462
if self._cache_sample_metadata is None:
5563
path = os.path.join(self._path, self.CONF["metadata_path"])
5664
with self._fs.open(path) as f:
5765
self._cache_sample_metadata = pd.read_csv(f, sep="\t", na_values="")
5866
return self._cache_sample_metadata
5967

6068
def _open_variant_calls_zarr(self):
69+
"""Open variant calls zarr.
70+
71+
Returns
72+
-------
73+
root : zarr.hierarchy.Group
74+
Root of zarr containing information on variant calls.
75+
76+
"""
6177
if self._cache_variant_calls_zarr is None:
6278
path = os.path.join(self._path, self.CONF["variant_calls_zarr_path"])
6379
store = _init_zarr_store(fs=self._fs, path=path)
@@ -180,6 +196,14 @@ def variant_calls(self, extended=False, inline_array=True, chunks="native"):
180196
return ds
181197

182198
def open_genome(self):
199+
"""Open the reference genome zarr.
200+
201+
Returns
202+
-------
203+
root : zarr.hierarchy.Group
204+
Zarr hierarchy containing the reference genome sequence.
205+
206+
"""
183207
if self._cache_genome is None:
184208
path = os.path.join(self._path, self.CONF["reference_path"])
185209
store = _init_zarr_store(fs=self._fs, path=path)

0 commit comments

Comments
 (0)