voiage.methods.causal_transportability.value_of_causal_transportability

value_of_causal_transportability

value_of_causal_transportability([positional or keyword] net_benefits: np.ndarray = None, [positional or keyword] source_population_ids: Sequence[str] = None, [positional or keyword] target_population_ids: Sequence[str] = None, [positional or keyword] strategy_names: Sequence[str] = None, [positional or keyword] transport_weights: np.ndarray = None, [positional or keyword] validity_penalties: np.ndarray = None, [keyword-only] analysis_id: str = 'causal-transportability-analysis', [keyword-only] decision_problem_id: str = 'unspecified', [keyword-only] reference_target_population: str | None = None) -> CausalTransportabilityResult

Value causal evidence transported from source to target populations.

net_benefits has shape (samples, sources, strategies). Each target receives a weighted source estimate, reduced by its validity penalty; the returned value is the gain from target-specific decisions over the reference target’s decision rule.

Parameters:

• net_benefits np.ndarray
• source_population_ids Sequence[str]
• target_population_ids Sequence[str]
• strategy_names Sequence[str]
• transport_weights np.ndarray
• validity_penalties np.ndarray
• analysis_id str (default: 'causal-transportability-analysis')
• decision_problem_id str (default: 'unspecified')
• reference_target_population str | None (default: None)

Returns: CausalTransportabilityResult