Skip to content

Commit 87bf12d

Browse files
committed
separate citation documentation inot citation.md and update table of contents
1 parent 5170a23 commit 87bf12d

File tree

3 files changed

+34
-14
lines changed

3 files changed

+34
-14
lines changed

docs/_toc.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,5 +14,6 @@ chapters:
1414
sections:
1515
- file: python-api
1616
- file: cli
17+
- file: citation
1718
- file: bibliography
1819
- file: CHANGELOG

docs/citation.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
jupytext:
3+
text_representation:
4+
extension: .md
5+
format_name: myst
6+
format_version: 0.12
7+
jupytext_version: 1.9.1
8+
kernelspec:
9+
display_name: Python 3
10+
language: python
11+
name: python3
12+
---
13+
14+
:::{currentmodule} tsdate
15+
:::
16+
17+
(sec_citation)=
18+
19+
# Citation
20+
21+
The algorithm for the `inside_outside` and `maximization` methods is described
22+
in [our Science paper](https://www.science.org/doi/10.1126/science.abi8264) (citation below,
23+
preprint [here](https://www.biorxiv.org/content/10.1101/2021.02.16.431497v2)).
24+
[Another repository](https://github.com/awohns/unified_genealogy_paper) provides
25+
code to reproduce evaluations of the accuracy and computational requirements of these methods.
26+
The default `variational_gamma` method has not yet been described in print. For the moment,
27+
please cite this github repository if you need a citable reference.
28+
29+
The original _tsdate_ algorithm, which you should cite in published work, is published in:
30+
31+
> Anthony Wilder Wohns, Yan Wong, Ben Jeffery, Ali Akbari, Swapan Mallick, Ron Pinhasi, Nick Patterson, David Reich, Jerome Kelleher, and Gil McVean (2022) *A unified genealogy of modern and ancient genomes*. Science **375**: eabi8264; doi: https://doi.org/10.1126/science.abi8264
32+
33+

docs/index.md

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -48,17 +48,3 @@ we suggest also checking the [discussions list](https://github.com/tskit-dev/tsd
4848
Pull requests are welcome: we largely follow the
4949
[tskit development workflow](https://tskit.dev/tskit/docs/latest/development.html#workflow).
5050

51-
## Citing
52-
53-
The algorithm for the `inside_outside` and `maximization` methods is described
54-
in [our Science paper](https://www.science.org/doi/10.1126/science.abi8264) (citation below,
55-
preprint [here](https://www.biorxiv.org/content/10.1101/2021.02.16.431497v2)).
56-
[Another repository](https://github.com/awohns/unified_genealogy_paper) provides
57-
code to reproduce evaluations of the accuracy and computational requirements of these methods.
58-
The default `variational_gamma` method has not yet been described in print. For the moment,
59-
please cite this github repository if you need a citable reference.
60-
61-
The original _tsdate_ algorithm, which you should cite in published work, is published in:
62-
63-
> Anthony Wilder Wohns, Yan Wong, Ben Jeffery, Ali Akbari, Swapan Mallick, Ron Pinhasi, Nick Patterson, David Reich, Jerome Kelleher, and Gil McVean (2022) *A unified genealogy of modern and ancient genomes*. Science **375**: eabi8264; doi: https://doi.org/10.1126/science.abi8264
64-

0 commit comments

Comments
 (0)