Filter ancestries by generation threshold

Filters alpha values in an outbreaker_chains object based on a specified threshold for kappa, removing ancestors beyond the given number of generations.

Usage

filter_alpha_by_kappa(out, kappa_max)

Arguments

out

A data frame of class outbreaker_chains.

kappa_max

A single integer specifying the maximum allowed number of generations (kappa).

Value

A modified outbreaker_chains data frame with alpha values filtered based on the kappa threshold. That means that if the value of kappa is greater than kappa_max, the corresponding alpha value will be set to NA.

Examples

if (FALSE) { # \dontrun{
filter_alpha_by_kappa(out, kappa_max = 1)
} # }