malariagen_data.ag3.Ag3.plot_g123_gwss

Ag3.plot_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, sample_query_options: dict | None = None, min_cohort_size: int | None = 20, max_cohort_size: int | None = 50, random_seed: int = 42, title: str | bool | None = None, sizing_mode: Literal['fixed', 'stretch_width', 'stretch_height', 'stretch_both', 'scale_width', 'scale_height', 'scale_both'] = 'stretch_width', width: int | None = None, track_height: int = 170, genes_height: int = 90, show: bool = True, output_backend: Literal['canvas', 'webgl', 'svg'] = 'webgl', inline_array: bool = True, chunks: int | str | Tuple[int | str, ...] | Callable[[Tuple[int, ...]], int | str | Tuple[int | str, ...]] = 'native', gene_labels: Mapping[str, str] | None = None, gene_labelset: LabelSet | None = None) → Model | None

Plot G123 GWSS data.

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.

sample_query_optionsdict or None, optional

A dictionary of arguments that will be passed through to pandas query() or eval(), e.g. parser, engine, local_dict, global_dict, resolvers.

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.

titlestr or bool or None, optional

Plot title. If True, a title may be automatically generated.

sizing_mode{‘fixed’, ‘stretch_width’, ‘stretch_height’, ‘stretch_both’, ‘scale_width’, ‘scale_height’, ‘scale_both’}, optional, default: ‘stretch_width’

Bokeh plot sizing mode, see also https://docs.bokeh.org/en/latest/docs /user_guide/basic/layouts.html#sizing-modes.

widthint or None, optional

Plot width in pixels (px).

track_heightint, optional, default: 170

Main track height in pixels (px).

genes_heightint, optional, default: 90

Genes track height in pixels (px).

showbool, optional, default: True

If true, show the plot. If False, do not show the plot, but return the figure.

output_backend{‘canvas’, ‘webgl’, ‘svg’}, optional, default: ‘webgl’

Specify an output backend to render a plot area onto. See also https://docs.bokeh.org/en/latest/docs/user_guide/output/webgl.html.

inline_arraybool, optional, default: True

Passed through to dask from_array().

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

Define how input data being read from zarr should be divided into chunks for a dask computation. If ‘native’, use underlying zarr chunks. If a string specifying a target memory size, e.g., ‘300 MiB’, resize chunks in arrays with more than one dimension to match this size. If ‘auto’, let dask decide chunk size. If ‘ndauto’, let dask decide chunk size but only for arrays with more than one dimension. If ‘ndauto0’, as ‘ndauto’ but only vary the first chunk dimension. If ‘ndauto1’, as ‘ndauto’ but only vary the second chunk dimension. If ‘ndauto01’, as ‘ndauto’ but only vary the first and second chunk dimensions. Also, can be a tuple of integers, or a callable which accepts the native chunks as a single argument and returns a valid dask chunks value.

gene_labelsMapping[str, str] or None, optional

A mapping of gene identifiers to custom labels, which will appear in the plot.

gene_labelsetLabelSet or None, optional

A LabelSet to use in the plot.

Returns

Model or None

A bokeh figure (only returned if show=False).