Parameters¶

data_cols¶

Preferred parameter for selecting exact data columns. See also: Column selection.

filtered_columns¶

Legacy/internal alias for data_cols (exact column names). Prefer data_cols in new code. See also: Column selection.

data_col_contains¶

Select columns whose names contain one or more text fragments. See also: Column selection.

column_strings¶

Legacy/internal alias for data_col_contains. Case-sensitive substring matching; prefer data_col_contains. See also: Column selection.

data_col_regex¶

Select columns with a regular expression. See also: Column selection.

regex_string¶

Legacy/internal alias for data_col_regex (a Python regular-expression string). Prefer data_col_regex. See also: Column selection.

data_col_exclude¶

Remove selected columns by text or pattern after inclusion. See also: Column selection.

exclude¶

Legacy/internal alias for data_col_exclude. Removes columns whose names contain any token; it does not remove rows. See also: Column selection.

filter_by¶

Preferred row filter parameter. specificity is the legacy/internal alias. See also: Filter By and row filters.

specificity¶

Legacy row-filter parameter, not statistical specificity. See also: Filter By and row filters.

split_by¶

Parameter for splitting a plot by conditions or a factor column. See also: Groups and factors.

factor¶

Legacy/internal parameter that panels an analysis by the levels of one factor column, such as Diagnosis or Sex. Prefer split_by in new code. See also: Groups and factors.

group¶

A grouping label in some pipeline and modelling functions. See also: Groups and factors.

group_col¶

Preferred name for a single grouping column. See also: Groups and factors.

condition_col¶

Legacy or input-facing name for a condition/group column. See also: from_dataframe.

group_cols¶

Preferred name for multiple grouping or factor columns. See also: Groups and factors.

factor_cols¶

Alias for multiple factor columns in DataFrame inputs. See also: from_dataframe.

subject_col¶

Preferred name for the subject identifier column. See also: Summary table.

animal_col¶

Legacy alias for the subject identifier column. See also: from_dataframe.

comparisons¶

The requested group comparisons, usually resolved to index strings like 1-2. See also: Groups and factors.

multiple_comparison¶

Controls multiple-testing adjustment in applicable statistical functions. See also: Statistics options.

force_nonparametric¶

Forces nonparametric testing where supported. See also: Statistics options.

posthoc_correction¶

Controls correction for posthoc comparisons where supported. See also: Statistics options.

roi¶

Selects a region or ROI base for data extraction or plotting. See also: ROI parameters.

save¶

Whether a function should write outputs to disk. See also: Saving parameters.

save_path¶

An explicit destination path for saved output where supported. See also: Saving parameters.

output_dir¶

An output directory for pipeline or modelling functions. See also: Model sweep outputs.

run_label¶

A label used to name or organize a saved run. See also: Saving parameters.

if_exists¶

An overwrite policy used by some output-producing functions. See also: Saving parameters.

cv¶

Cross-validation setting, such as stratified5, stratifiedN, or loo in classification sweeps. See also: Model options.

scoring¶

The metric used to rank model outputs. See also: Model options.

model_preset¶

Classifier-grid size for iterative_model_sweep: ultra_compact, compact, or full. See also: Model options.

search_strategy¶

Feature-subset search mode, usually exhaustive or beam for model sweeps. See also: Model options.

n_jobs¶

Number of parallel scoring workers for supported model functions. See also: Model options.

checkpoint_every¶

How often model sweeps write partial score checkpoints. See also: Model sweep outputs.

resume¶

Whether a model sweep should continue from a matching partial checkpoint. See also: Model sweep outputs.

random_state¶

A seed used to make stochastic model steps reproducible. See also: Model options.

image_backend¶

The image reader backend used by image plotting functions. See also: Image panels.

fast_loading¶

Image plotting option that trades full-resolution loading for faster previews where supported. See also: Image panels.

preview_max_dim¶

Maximum preview dimension for faster image rendering. See also: Image panels.

markers¶

The marker or channel names requested by an image, summary, or colocalisation plot. See also: Markers.