malariagen_data.ag3.Ag3.g123_gwss

Ag3.g123_gwss(contig: str, window_size: int, sites: str = 'default', site_mask: str | None = 'default', sample_sets: Sequence[str] | str | None = None, sample_query: str | None = None, min_cohort_size: int | None = 20, max_cohort_size: int | None = 50, random_seed: int = 42, inline_array: bool = True, chunks: str | Tuple[int, ...] | Callable[[Tuple[int, ...]], Tuple[int, ...]] = 'native') → Tuple[ndarray, ndarray]

Run a G123 genome-wide selection scan.

Parameters

contigstr

Reference genome contig name. See the contigs property for valid contig names.

window_sizeint

The size of windows (number of sites) used to calculate statistics within.

sitesstr, optional, default: ‘default’

Which sites to use: ‘all’ includes all sites that pass site filters; ‘segregating’ includes only segregating sites for the given cohort; or a phasing analysis identifier can be provided to use sites from the haplotype data, which is an approximation to finding segregating sites in the entire Ag3.0 (gambiae complex) or Af1.0 (funestus) cohort.

site_maskstr or None, optional, default: ‘default’

Which site filters mask to apply. See the site_mask_ids property for available values.

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.

min_cohort_sizeint or None, optional, default: 20

Minimum cohort size. Raise an error if the number of samples is less than this value.

max_cohort_sizeint or None, optional, default: 50

Randomly down-sample to this value if the number of samples in the cohort is greater.

random_seedint, optional, default: 42

Random seed used for reproducible down-sampling.

inline_arraybool, optional, default: True

Passed through to dask from_array().

chunksstr or tuple of int or Callable[[typing.Tuple[int, …]], tuple of int], optional, default: ‘native’

If ‘auto’ let dask decide chunk size. If ‘native’ use native zarr chunks. Also, can be a target size, e.g., ‘200 MiB’, or a tuple of integers.

Returns

xndarray

An array containing the window centre point genomic positions.

g123ndarray

An array with G123 statistic values for each window.