Skip to content

Commit fe05786

Browse files
committed
Landing page and tiny updates elsewhere
1 parent f37e7b9 commit fe05786

File tree

3 files changed

+11
-11
lines changed

3 files changed

+11
-11
lines changed

docs/src/index.md

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -21,20 +21,16 @@ hero:
2121
link: https://github.com/MurrellGroup/MolecularEvolution.jl
2222
features:
2323
- title: Flexible Model Development
24-
details: Create custom evolutionary models with your own data types and probability distributions while leveraging the existing infrastructure for tree operations and likelihood calculations.
24+
details: Create custom evolutionary models by defining how your new (or already existing) probability distributions evolve along a branch, and get likelihood calculations (and much more) for free! • Mix and match different models on the same phylogeny.
2525
link: /framework
2626
- title: Rich Model Library
27-
details: Includes standard models like JC69, K80, GTR for nucleotides, JTT and WAG for amino acids, MG94 and GY94 for codons, plus Brownian motion for continuous traits.
27+
details: Codon, AA, nucleotide and generic discrete character models as well as continuous Brownian motion in 1D. Site- and branch-wise mixture models and more.
2828
link: /models
2929
- title: Powerful Tree Operations
30-
details: Optimize branch lengths, infer ancestral states, perform tree rearrangements (NNI), and sample topologies with MCMC.
30+
details: Optimize model parameters, branch lengths and root state/location. Perform tree rearrangements (NNI). The above can also be made in the Bayesian framework by sampling over posterior tree and parameter spaces with MCMC. • Infer ancestral states.
3131
link: /optimization
3232
- title: Simulation Tools
33-
details: Generate phylogenies using both coalescent and birth-death processes, and simulate sequence evolution on those trees.
33+
details: Generate phylogenies using e.g. coalescent and logistic growth processes, and simulate both sequence evolution and continuous trait evolution on those trees.
3434
link: /simulation
3535
---
36-
```
37-
38-
```@meta
39-
CurrentModule = MolecularEvolution
40-
```
36+
```

docs/src/models.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Models
22

3-
We offer a catalogue of frequent models that are already integrated with the framework and ready to be used.
3+
We offer a catalogue of frequently used models that are already integrated with the framework and ready to be used.
44
We maintain that if a model you'd like to use is not included in the list, you can swiftly define one yourself and
55
leverage our framework nonetheless.
66

@@ -25,7 +25,7 @@ And then there are two typical `BranchModel`s that will cooperate with this `Par
2525
!!! note
2626
The two above can be regarded as special cases of the more general [`PModel`](@ref), which just represents a P matrix.
2727

28-
A typical way of constructing your Q matrix in our ecosystem is by
28+
A typical way of constructing your Q matrix in our ecosystem is by:
2929
```@docs; canonical=false
3030
reversibleQ
3131
nonreversibleQ

docs/src/optimization.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@ There are two distinct kinds of optimization: "global" model parameters, and the
44

55
The example below will set up and optimize a ["Generalized Time Reversible" nucleotide substitution model](https://en.wikipedia.org/wiki/Substitution_model), where there are 6 rate parameters that govern the symmetric part of a rate matrix, and 4 nucleotide frequencies (that sum to 1, so only 3 underlying parameters).
66

7+
!!! note
8+
For the Bayesian counterpart of this page, we refer you to [Set up a Bayesian model sampler](@ref) and [Multiple trees](@ref).
9+
710
## Optimizing model parameters
811

912
We first need to construct an objective function. A very common use case involves parameterizing a rate matrix (along with all the constraints this entails) from a flat parameter vector. `reversibleQ` can be convenient here, which takes a vector of parameters and equilibrium frequencies and returns a reversible rate matrix.
@@ -158,5 +161,6 @@ reversibleQ
158161
unc2probvec
159162
branchlength_optim!
160163
nni_optim!
164+
root_optim!
161165
tree_polish!
162166
```

0 commit comments

Comments
 (0)