From 83009eb3c82e538cc0adb2827681b012ed004063 Mon Sep 17 00:00:00 2001 From: Matt Jones Date: Wed, 8 May 2024 11:10:00 -0700 Subject: [PATCH] updated docs --- cassiopeia/simulator/BirthDeathFitnessSimulator.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/cassiopeia/simulator/BirthDeathFitnessSimulator.py b/cassiopeia/simulator/BirthDeathFitnessSimulator.py index b2d7e681..1467e064 100644 --- a/cassiopeia/simulator/BirthDeathFitnessSimulator.py +++ b/cassiopeia/simulator/BirthDeathFitnessSimulator.py @@ -95,7 +95,11 @@ class BirthDeathFitnessSimulator(TreeSimulator): collapse_unifurcations: Specifies whether to collapse unifurcations in the tree resulting from pruning dead lineages random_seed: A seed for reproducibility - initial_tree: A tree used for initializing the simulation. + initial_tree: A tree used for initializing the simulation. When this + argument is passed, a simulation will pick up from the leaves of the + specified tree. This can be useful for simulating trees when + selection may change over time (for example, in the presence + or absence of a drug pressure). Raises: TreeSimulatorError if invalid stopping conditions are provided or if a