malariagen_data.ag3.Ag3.plot_h12_gwss_multi_overlay

Ag3.plot_h12_gwss_multi_overlay(contig: str, cohorts: str | Mapping[str, str], window_size: int | dict[str, int], cohort_size: int | None = None, sample_query: str | None = None, analysis: str = 'default', min_cohort_size: int | None = 15, max_cohort_size: int | None = 50, sample_query_options: dict | None = None, sample_sets: Sequence[str] | str | None = None, colors: Sequence[str] = ('#1f77b4', '#ff7f0e', '#2ca02c', '#d62728', '#9467bd', '#8c564b', '#e377c2', '#7f7f7f', '#bcbd22', '#17becf'), 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') → Model | None

Plot h12 GWSS data with multiple traces overlaid.

Parameters

contigstr

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

cohortsstr or Mapping[str, str]

Either a string giving the name of a predefined cohort set (e.g., “admin1_month”) or a dict mapping custom cohort labels to sample queries.

window_sizeint or dict[str, int]

The size of windows (number of SNPs) used to calculate statistics within. Can be a single value, in which case the same window size will be used for all cohorts. Can also be a mapping from cohort identifiers to values, in case you need to provide different window sizes for different cohorts.

cohort_sizeint or None, optional

Randomly down-sample to this value if the number of samples in the cohort is greater. Raise an error if the number of samples is less than this value.

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.

analysisstr, optional, default: ‘default’

Which haplotype phasing analysis to use. See the phasing_analysis_ids property for available values.

min_cohort_sizeint or None, optional, default: 15

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.

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.

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.

colorssequence of str, optional, default: (‘#1f77b4’, ‘#ff7f0e’, ‘#2ca02c’, ‘#d62728’, ‘#9467bd’, ‘#8c564b’, ‘#e377c2’, ‘#7f7f7f’, ‘#bcbd22’, ‘#17becf’)

List of colors.

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.

Returns

Model or None

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