Skip to content

Commit 7eb40a7

Browse files
agladsteinbenjeffery
authored andcommitted
added citation page to docs
1 parent c3c533a commit 7eb40a7

3 files changed

Lines changed: 92 additions & 0 deletions

File tree

docs/_toc.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,3 +27,7 @@ parts:
2727
chapters:
2828
- file: development
2929
- file: changelogs
30+
- caption: Miscellaneous
31+
chapters:
32+
- file: citation
33+

docs/citation.md

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
(sec_citation)=
2+
3+
# Citing tskit
4+
5+
If you use `tskit` in your work, please cite the [zenodo DOI](<https://zenodo.org/records/15121152>) (*Remember to update the version to the version you used*):
6+
7+
> Jerome Kelleher, Ben Jeffery, Yan Wong, Peter Ralph, Georgia Tsambos, Shing Hei Zhan,
8+
> Kevin R. Thornton, Daniel Goldstein, Nate Pope, lkirk, Anthony Wilder Wohns, Duncan
9+
> Mbuli-Robertson, pyup.io bot, Graham Gower, Hugo van Kemenade, Brian Zhang, Murillo F.
10+
> Rodrigues, Castedo Ellerman, Duncan Palmer, … Saurabh Belsare. (2025). tskit-dev/tskit:
11+
> Python 0.6.2 (0.6.2). Zenodo. https://doi.org/10.5281/zenodo.15121152
12+
13+
We also recommend citing the [2024 ARG Genetics paper](<https://doi.org/10.1093/genetics/iyae100>) and the [2016 msprime PLOS Computational Biology paper](<http://dx.doi.org/10.1371/journal.pcbi.1004842>):
14+
> Yan Wong, Anastasia Ignatieva, Jere Koskela, Gregor Gorjanc, Anthony W
15+
> Wohns, Jerome Kelleher, *A general and efficient representation of ancestral
16+
> recombination graphs*, Genetics, Volume 228, Issue 1, September 2024, iyae100,
17+
> https://doi.org/10.1093/genetics/iyae100
18+
19+
> Jerome Kelleher, Alison M Etheridge and Gilean McVean (2016),
20+
> *Efficient Coalescent Simulation and Genealogical Analysis for Large Sample Sizes*,
21+
> PLOS Comput Biol 12(5): e1004842. doi: 10.1371/journal.pcbi.1004842
22+
23+
If you use summary statistics, please cite the
24+
[2020 Genetics paper](https://doi.org/10.1534/genetics.120.303253):
25+
26+
> Peter Ralph, Kevin Thornton, Jerome Kelleher, *Efficiently Summarizing
27+
> Relationships in Large Samples: A General Duality Between Statistics of
28+
> Genealogies and Genomes*, Genetics, Volume 215, Issue 3, 1 July 2020,
29+
> Pages 779–797, https://doi.org/10.1534/genetics.120.303253
30+
31+
32+
Bibtex records:
33+
34+
```bibtex
35+
% UPDATE TO THE VERSION YOU USED
36+
@software{Kelleher2025tskitzenodo,
37+
author = {Jerome Kelleher and Ben Jeffery and Yan Wong and Peter Ralph and Georgia Tsambos and
38+
Shing Hei Zhan and Kevin R. Thornton and Daniel Goldstein and Nate Pope and lkirk and
39+
Anthony Wilder Wohns and Duncan Mbuli-Robertson and pyup.io bot and Graham Gower and
40+
Hugo van Kemenade and Brian Zhang and Murillo F. Rodrigues and Castedo Ellerman and
41+
Duncan Palmer and Clemens Weiss and Gertjan Bisschop and Jeremy Guez and Savita Karthikeyan and
42+
Hanbin Lee and Ao Zhang and Inés Rebollo and Saurabh Belsare},
43+
title = {tskit-dev/tskit: Python 0.6.2},
44+
publisher = {Zenodo},
45+
year = {2025},
46+
version = {0.6.2},
47+
doi = {10.5281/zenodo.15121152}
48+
}
49+
50+
@article{Wong2024ARGs,
51+
author = {Wong, Yan and Ignatieva, Anastasia and Koskela, Jere and Gorjanc, Gregor and
52+
Wohns, Anthony W and Kelleher, Jerome},
53+
title = {A general and efficient representation of ancestral recombination graphs},
54+
journal = {Genetics},
55+
volume = {228},
56+
number = {1},
57+
pages = {iyae100},
58+
year = {2024},
59+
doi = {10.1093/genetics/iyae100}
60+
}
61+
62+
@article{Kelleher2016msprime,
63+
author = {Kelleher, Jerome and Etheridge, Alison M and McVean, Gilean},
64+
title = {Efficient coalescent simulation and genealogical analysis for large sample sizes},
65+
journal = {PLoS Computational Biology},
66+
volume = {12},
67+
number = {5},
68+
pages = {e1004842},
69+
year = {2016},
70+
publisher = {Public Library of Science}
71+
}
72+
73+
@article{Ralph2020Stats,
74+
author = {Ralph, Peter and Thornton, Kevin and Kelleher, Jerome},
75+
title = {Efficiently Summarizing Relationships in Large Samples: A General Duality Between Statistics of Genealogies and Genomes},
76+
journal = {Genetics},
77+
volume = {215},
78+
number = {3},
79+
pages = {779--797},
80+
year = {2020},
81+
doi = {10.1534/genetics.120.303253}
82+
}
83+
84+
```

docs/introduction.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,10 @@ For a gentle introduction, you might like to read "{ref}`tutorials:sec_what_is`"
3939
on our {ref}`tutorials site<tutorials:sec_intro>`. There you can also find further
4040
tutorial material to introduce you to the key concepts behind succinct tree sequences.
4141

42+
:::{important}
43+
If you use `tskit` in your work, please remember to cite it appropriately: see the {ref}`citations<sec_citation>` page for details.
44+
:::
45+
4246
:::{note}
4347
This documentation is under active development and may be incomplete
4448
in some areas. If you would like to help improve it, please open an issue or

0 commit comments

Comments
 (0)