moscot.utils.subset_policy.SubsetPolicy.plan

SubsetPolicy.plan(filter=None, explicit_steps=None, **kwargs)

Compute a sequence of steps based on the policy graph.

Useful when calling create_masks().

Parameters:

• filter (Optional[Sequence[Tuple[TypeVar(K, bound= Hashable), TypeVar(K, bound= Hashable)]]]) – Steps to exclude. If None, keep all the steps.

• explicit_steps (Optional[Sequence[Tuple[TypeVar(K, bound= Hashable), TypeVar(K, bound= Hashable)]]]) – Precomputed sequence of steps to use.

• kwargs (Any) – Additional keyword arguments.

Return type:

Sequence[Tuple[TypeVar(K, bound= Hashable), TypeVar(K, bound= Hashable)]]

Returns:

: Sequence of steps.