Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/_toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,7 @@ parts:
chapters:
- file: development
- file: changelogs
- caption: Miscellaneous
chapters:
- file: citation

84 changes: 84 additions & 0 deletions docs/citation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
(sec_citation)=

# Citing tskit

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*):

> Jerome Kelleher, Ben Jeffery, Yan Wong, Peter Ralph, Georgia Tsambos, Shing Hei Zhan,
> Kevin R. Thornton, Daniel Goldstein, Nate Pope, lkirk, Anthony Wilder Wohns, Duncan
> Mbuli-Robertson, pyup.io bot, Graham Gower, Hugo van Kemenade, Brian Zhang, Murillo F.
> Rodrigues, Castedo Ellerman, Duncan Palmer, … Saurabh Belsare. (2025). tskit-dev/tskit:
> Python 0.6.2 (0.6.2). Zenodo. https://doi.org/10.5281/zenodo.15121152

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>):
> Yan Wong, Anastasia Ignatieva, Jere Koskela, Gregor Gorjanc, Anthony W
> Wohns, Jerome Kelleher, *A general and efficient representation of ancestral
> recombination graphs*, Genetics, Volume 228, Issue 1, September 2024, iyae100,
> https://doi.org/10.1093/genetics/iyae100

> Jerome Kelleher, Alison M Etheridge and Gilean McVean (2016),
> *Efficient Coalescent Simulation and Genealogical Analysis for Large Sample Sizes*,
> PLOS Comput Biol 12(5): e1004842. doi: 10.1371/journal.pcbi.1004842

If you use summary statistics, please cite the
[2020 Genetics paper](https://doi.org/10.1534/genetics.120.303253):

> Peter Ralph, Kevin Thornton, Jerome Kelleher, *Efficiently Summarizing
> Relationships in Large Samples: A General Duality Between Statistics of
> Genealogies and Genomes*, Genetics, Volume 215, Issue 3, 1 July 2020,
> Pages 779–797, https://doi.org/10.1534/genetics.120.303253


Bibtex records:

```bibtex
% UPDATE TO THE VERSION YOU USED
@software{Kelleher2025tskitzenodo,
author = {Jerome Kelleher and Ben Jeffery and Yan Wong and Peter Ralph and Georgia Tsambos and
Shing Hei Zhan and Kevin R. Thornton and Daniel Goldstein and Nate Pope and lkirk and
Anthony Wilder Wohns and Duncan Mbuli-Robertson and pyup.io bot and Graham Gower and
Hugo van Kemenade and Brian Zhang and Murillo F. Rodrigues and Castedo Ellerman and
Duncan Palmer and Clemens Weiss and Gertjan Bisschop and Jeremy Guez and Savita Karthikeyan and
Hanbin Lee and Ao Zhang and Inés Rebollo and Saurabh Belsare},
title = {tskit-dev/tskit: Python 0.6.2},
publisher = {Zenodo},
year = {2025},
version = {0.6.2},
doi = {10.5281/zenodo.15121152}
}

@article{Wong2024ARGs,
author = {Wong, Yan and Ignatieva, Anastasia and Koskela, Jere and Gorjanc, Gregor and
Wohns, Anthony W and Kelleher, Jerome},
title = {A general and efficient representation of ancestral recombination graphs},
journal = {Genetics},
volume = {228},
number = {1},
pages = {iyae100},
year = {2024},
doi = {10.1093/genetics/iyae100}
}

@article{Kelleher2016msprime,
author = {Kelleher, Jerome and Etheridge, Alison M and McVean, Gilean},
title = {Efficient coalescent simulation and genealogical analysis for large sample sizes},
journal = {PLoS Computational Biology},
volume = {12},
number = {5},
pages = {e1004842},
year = {2016},
publisher = {Public Library of Science}
}

@article{Ralph2020Stats,
author = {Ralph, Peter and Thornton, Kevin and Kelleher, Jerome},
title = {Efficiently Summarizing Relationships in Large Samples: A General Duality Between Statistics of Genealogies and Genomes},
journal = {Genetics},
volume = {215},
number = {3},
pages = {779--797},
year = {2020},
doi = {10.1534/genetics.120.303253}
}

```
4 changes: 4 additions & 0 deletions docs/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,10 @@ For a gentle introduction, you might like to read "{ref}`tutorials:sec_what_is`"
on our {ref}`tutorials site<tutorials:sec_intro>`. There you can also find further
tutorial material to introduce you to the key concepts behind succinct tree sequences.

:::{important}
If you use `tskit` in your work, please remember to cite it appropriately: see the {ref}`citations<sec_citation>` page for details.
:::

:::{note}
This documentation is under active development and may be incomplete
in some areas. If you would like to help improve it, please open an issue or
Expand Down
Loading