malariagen_data.ag3.Ag3.sample_metadata

Ag3.sample_metadata(sample_sets: Sequence[str] | str | None = None, sample_query: str | None = None, sample_indices: List[int] | None = None) → DataFrame

Access sample metadata for one or more sample sets.

Parameters

sample_setssequence of str or str or None, optional

List of sample sets and/or releases. Can also be a single sample set or release.

sample_querystr or None, optional

A pandas query string to be evaluated against the sample metadata, to select samples to be included in the returned data.

sample_indiceslist of int or None, optional

Advanced usage parameter. A list of indices of samples to select, corresponding to the order in which the samples are found within the sample metadata. Either provide this parameter or sample_query, not both.

Returns

DataFrame

A dataframe of sample metadata, one row per sample.