Skip to content

Commit 50b7df8

Browse files
committed
Add citation for tskit
Fixes #46
1 parent 052c7be commit 50b7df8

4 files changed

Lines changed: 35 additions & 29 deletions

File tree

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,9 @@
55
`Tskit` enables performant storage, manipulation, and analysis of ancestral
66
recombination graphs (ARGs) using succinct tree sequence encoding.
77
The tree sequence encoding of an ARG is
8-
described in Wong et al. (2024) <doi:10.1093/genetics/iyae100>.
8+
described in Wong et al. (2024) <doi:10.1093/genetics/iyae100>,
9+
while `tskit` project is described in
10+
Jeffrey et al. (2026) <doi:10.48550/arXiv.2602.09649>.
911
See https://tskit.dev for project news, documentation, and tutorials.
1012
`Tskit` provides Python, C, and Rust application programming interfaces (APIs).
1113
The Python API can be called from R via the `reticulate` R package to

RcppTskit/DESCRIPTION

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -9,20 +9,21 @@ Authors@R: c(
99
person("Tskit Developers", role = "cph",
1010
comment = "Authors of included tskit C library")
1111
)
12-
Description: 'Tskit' enables efficient storage, manipulation, and
13-
analysis of ancestral recombination graphs (ARGs) using succinct tree
14-
sequence encoding. The tree sequence encoding of an ARG is described
15-
in Wong et al. (2024) <doi:10.1093/genetics/iyae100>. See also
16-
<https://tskit.dev> for project news, documentation, and tutorials.
17-
'Tskit' provides Python, C, and Rust application programming
18-
interfaces (APIs). The Python API can be called from R via the
19-
'reticulate' package to load and analyse tree sequences as described
20-
at <https://tskit.dev/tutorials/tskitr.html>. 'RcppTskit' provides R
21-
access to the 'tskit' C API for cases where the 'reticulate' option
22-
is not optimal; for example, high-performance or low-level work with
23-
tree sequences. Currently, 'RcppTskit' provides a limited set of R
24-
functions because the Python API and 'reticulate' already covers
25-
most needs.
12+
Description: 'Tskit' enables efficient storage, manipulation, and analysis
13+
of ancestral recombination graphs (ARGs) using succinct tree sequence
14+
encoding. The tree sequence encoding of an ARG is described in Wong et
15+
al. (2024) <doi:10.1093/genetics/iyae100>, while `tskit` project is
16+
described in Jeffrey et al. (2026) <doi:10.48550/arXiv.2602.09649>.
17+
See also <https://tskit.dev> for project news, documentation, and
18+
tutorials. 'Tskit' provides Python, C, and Rust application
19+
programming interfaces (APIs). The Python API can be called from R via
20+
the 'reticulate' package to load and analyse tree sequences as
21+
described at <https://tskit.dev/tutorials/tskitr.html>. 'RcppTskit'
22+
provides R access to the 'tskit' C API for cases where the
23+
'reticulate' option is not optimal; for example, high-performance or
24+
low-level work with tree sequences. Currently, 'RcppTskit' provides a
25+
limited set of R functions because the Python API and 'reticulate'
26+
already covers most needs.
2627
License: MIT + file LICENSE
2728
URL: https://github.com/HighlanderLab/RcppTskit
2829
BugReports: https://github.com/HighlanderLab/RcppTskit/issues

RcppTskit/R/RcppTskit-package.R

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@
44
#' `Tskit` enables efficient storage, manipulation, and analysis of
55
#' ancestral recombination graphs (ARGs) using succinct tree sequence encoding.
66
#' The tree sequence encoding of an ARG is described in Wong et al. (2024)
7-
#' <doi:10.1093/genetics/iyae100>.
7+
#' <doi:10.1093/genetics/iyae100>, while `tskit` project is
8+
#' described in Jeffrey et al. (2026) <doi:10.48550/arXiv.2602.09649>.
89
#' See also https://tskit.dev for project news, documentation, and tutorials.
910
#' `Tskit` provides Python, C, and Rust application programming interfaces (APIs).
1011
#' The Python API can be called from R via the `reticulate` package to

RcppTskit/vignettes/references.bib

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -38,15 +38,15 @@ @article{jeffrey2026population
3838
Bisschop, Gertjan and
3939
Deng, Yun and
4040
Ellerman, E Castedo and
41-
Forest, Thomas and
41+
Forest, B Thomas and
4242
Fritze, Halley and
4343
Goldstein, Daniel and
4444
Gorjanc, Gregor and
4545
Gower, Graham and
4646
Gravel, Simon and
4747
Guez, Jeremy and
48-
Haller, Benjamin C. and
49-
Kern, Andrew D. and
48+
Haller, Benjamin C and
49+
Kern, Andrew D and
5050
Kirk, Lloyd and
5151
Krukov, Ivan and
5252
Lee, Hanbin and
@@ -55,23 +55,23 @@ @article{jeffrey2026population
5555
Osmond, Matthew M and
5656
Palmer, Duncan S and
5757
Pope, Nathaniel S and
58-
Ragsdale, Aaron and
58+
Ragsdale, Aaron P and
5959
Robertson, Duncan and
6060
Rodrigues, Murillo F and
61-
Weiss, Clemens and
61+
van Kemenade, Hugo and
62+
Weiss, Clemens L and
6263
Wohns, Anthony Wilder and
6364
Zhan, Shing H and
64-
Zhang, Brian and
65-
van Kemenade, Hugo and
66-
Aspbury, Maz and
67-
Baya, Nik and
65+
Zhang, Brian C and
66+
Aspbury, Marianne and
67+
Baya, Nikolas A and
6868
Belsare, Saurabh and
6969
Biddanda, Arjun and
70-
Campuzano, Curro and
70+
Campuzano Jiménez, Francisco and
7171
Gladstein, Ariella and
7272
Guo, Bing and
7373
Karthikeyan, Savita and
74-
Kretzschumar, Warren W and
74+
Kretzschmar, Warren W and
7575
Rebollo, Inés and
7676
Saunack, Kumar and
7777
Shemirani, Ruhollah and
@@ -83,8 +83,10 @@ @article{jeffrey2026population
8383
Zhang, Ao and
8484
Ralph, Peter
8585
Kelleher, Jerome},
86-
journal = {TODO},
87-
year = {2026}
86+
journal = {arXiv},
87+
year = {2026},
88+
doi = {10.48550/arXiv.2602.09649},
89+
url = {https://arxiv.org/abs/2602.09649}
8890
}
8991

9092
@article{lewanski2024era,

0 commit comments

Comments
 (0)