tracts.driver_utils._get_optimization_subtitle

_get_optimization_subtitle(parameter_handler, two_steps_optimization, autosomes_in_step_2, steps=None)

Build the user-readable optimization subtitle for the active run phase. This helper determines which parameter set is being optimized in the current context and returns the corresponding subtitle string used in console/log headers.

Behavior

• Single-step mode: reports all currently free parameters.

• Two-step mode, step 2 only: reports sex-bias parameters only.

• Two-step mode, otherwise: reports non-sex-bias parameters (step 1 view).

• In two-step mode, parameters fixed by value or ancestry are excluded from the displayed list.

param parameter_handler:

Provides parameter metadata and fixed-parameter information.

type parameter_handler:

FixedParametersHandler

param two_steps_optimization:

Whether optimization is configured to run in two-step mode.

type two_steps_optimization:

bool

param autosomes_in_step_2:

If True, the step-2 subtitle references autosomal + allosomal data; otherwise it references allosomal data only.

type autosomes_in_step_2:

bool

param steps:

Optional explicit step selection. Accepted labels are 1/"step1" and 2/"step2". If None, both steps are assumed.

type steps:

list[int | str] | None

returns:

Subtitle describing the active optimization step and parameter subset.

rtype:

str