Skip to content

Commit f24b777

Browse files
committed
update doc
1 parent 85890ef commit f24b777

4 files changed

Lines changed: 21 additions & 19 deletions

File tree

doc/Complex-Models.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
layout: userdoc
33
title: "Complex Models"
44
author: 928003585, 95438353+HectorBanos, Dominik Schrempf, Jana Trifinopoulos, Minh Bui, Rob Lanfear, Thomaskf, Trongnhan Uit
5-
date: 2024-04-18
5+
date: 2024-07-31
66
docid: 11
77
icon: book
88
doctype: manual
@@ -156,15 +156,17 @@ Here, we estimate the optimal Q mixture model. To select mixture model and then
156156

157157
iqtree -s example.phy -m MIX+MFP
158158

159-
Likelihood ratio test (LRT) with p-value = 0.05 is the default method to assess the number of classes in the Q mixture model. To change the p-value:
159+
BIC is the default criterion to assess the number of classes in the Q mixture model. AIC, AICc or likelihood ratio test (LRT) are also available to assess the number of classes.
160160

161-
iqtree -s example.phy -m MIX+MF -lrt 0.01
161+
To use AIC:
162+
163+
iqtree -s example.phy -m MIX+MF -merit AIC
162164

163-
Here, we change the LRT p-value to 0.01. To use information criteria instead of LRT to assess the number of classes:
165+
To use likelihood ratio test with p-value = 0.05 to assess the number of classes:
164166

165-
iqtree -s example.phy -m MIX+MF -lrt 0 -merit BIC
167+
iqtree -s example.phy -m MIX+MF -lrt 0.05
166168

167-
Here, `-lrt 0` means turning off the LRT, then `-merit BIC` means using BIC to assess the number of classes. (Note that: `-merit` also decides the creterion for selecting subtitution model type in each classes. If using LRT for assessing the number of classes, the default creterion for selecting subtitution model type is BIC.)
169+
(Note that: `-merit` also decides the creterion for selecting subtitution model type in each classes. If using LRT for assessing the number of classes, the default creterion for selecting subtitution model type is BIC.)
168170

169171
Options for ModelFinder also work for MixtureFinder, e.g.:
170172

@@ -177,7 +179,7 @@ Other options for MixtureFinder:
177179
| Model option | Description |
178180
| -------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
179181
| `-qmax` | Maximum number of Q-mixture classes (default: 10). Specify a number after the option (e.g., `-qmax 5`). |
180-
| `-mrate-twice` | Whether estimate the rate heterogeneity across sites models again after select the best Q-mixture model. 1: yes, 0: no. (default: 1) |
182+
| `-mrate-twice` | Whether estimate the rate heterogeneity across sites models again after select the best Q-mixture model. 1: yes, 0: no. (default: 0) |
181183

182184
If you use MixtureFinder in a publication please cite:
183185

@@ -415,3 +417,4 @@ Please note that, in any MAST model with more than one substitution model (i.e.
415417
[Wang et al., 2008]: https://doi.org/10.1186/1471-2148-8-331
416418

417419

420+

doc/iqtree-doc.pdf

-351 Bytes
Binary file not shown.

doc/recipes/goldman-cox-test.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
22
layout: workshop
33
title: "Perform a Goldman-Cox test"
4-
author: Rob Lanfear
5-
date: 2022-06-07
4+
author: Minh Bui, Rob Lanfear
5+
date: 2024-07-06
66
docid: 100
77
---
88

99
# Perform a Goldman-Cox test
1010

11-
## What's a Goldman-Cox test
11+
## What is a Goldman-Cox test?
1212

1313
Nick Goldman explains the Goldman-Cox (GC) test in [this paper](https://link.springer.com/article/10.1007/BF00166252)
1414

doc/recipes/index.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,30 @@
11
---
22
layout: userdoc
33
title: "Recipes (How-To)"
4-
author: Rob Lanfear
5-
date: 2022-06-07
4+
author: Minh Bui, Rob Lanfear
5+
date: 2024-07-06
66
docid: 9.5
77
icon: question-circle
88
doctype: manual
99
tags:
1010
- manual
11-
description: Collection of one-off examples of analyses in IQ-TREE.
11+
description: Collection of examples that combine IQ-TREE with other software.
1212
sections_new_page: True
1313
sections:
1414
- name: Phylogenetic placement
1515
url: phylogenetic-placement
1616
- name: Perform a Goldman-Cox test
1717
url: goldman-cox-test
18+
- name: Estimating gene, site, and quartet concordance vectors
19+
url: concordance-vector
1820
---
1921

2022
# Recipes
2123

22-
This is a collection of one-off examples of analyses in IQ-TREE.
23-
<!--more-->
24-
One might call them "infrequently asked questions". The idea is a searchable and
25-
reproducible database of analyses to help the community do what they need to with IQ-TREE.
24+
This is a collection of detailed examples analyses that combine IQ-TREE with other bits of code and/or software (hence 'recipes'). They are an attempt to go a bit beyond the usual user docs for software, getting closer to end-to-end analyses. The idea is a searchable and reproducible database of analyses to help the community do what they need to with IQ-TREE.
2625

27-
If you'd like to request a recipe, please head over to the issues page and
28-
use the 'recipe wanted' label.
26+
If you'd like to request a recipe, please head over to the issues page and use the 'recipe wanted' label, and describe in as much detail as possible (with references and example data if you can) what it is you would like.
2927

3028
* [How to do phylogenetic placement](phylogenetic-placement)
3129
* [How to perform a Goldman-Cox test](goldman-cox-test)
30+
* [Estimating gene, site, and quartet concordance vectors](concordance-vector)

0 commit comments

Comments
 (0)