Skip to content

Commit

Permalink
updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mattjones315 committed May 8, 2024
1 parent a351abd commit 83009eb
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion cassiopeia/simulator/BirthDeathFitnessSimulator.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 83009eb

Please sign in to comment.