Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
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: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@
`Tskit` enables performant storage, manipulation, and analysis of ancestral
recombination graphs (ARGs) using succinct tree sequence encoding.
The tree sequence encoding of an ARG is
described in Wong et al. (2024) <doi:10.1093/genetics/iyae100>.
described in Wong et al. (2024) <doi:10.1093/genetics/iyae100>,
while `tskit` project is described in
Jeffrey et al. (2026) <doi:10.48550/arXiv.2602.09649>.
See https://tskit.dev for project news, documentation, and tutorials.
`Tskit` provides Python, C, and Rust application programming interfaces (APIs).
The Python API can be called from R via the `reticulate` R package to
Expand Down
29 changes: 15 additions & 14 deletions RcppTskit/DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -9,20 +9,21 @@ Authors@R: c(
person("Tskit Developers", role = "cph",
comment = "Authors of included tskit C library")
)
Description: 'Tskit' enables efficient storage, manipulation, and
analysis of ancestral recombination graphs (ARGs) using succinct tree
sequence encoding. The tree sequence encoding of an ARG is described
in Wong et al. (2024) <doi:10.1093/genetics/iyae100>. See also
<https://tskit.dev> for project news, documentation, and tutorials.
'Tskit' provides Python, C, and Rust application programming
interfaces (APIs). The Python API can be called from R via the
'reticulate' package to load and analyse tree sequences as described
at <https://tskit.dev/tutorials/tskitr.html>. 'RcppTskit' provides R
access to the 'tskit' C API for cases where the 'reticulate' option
is not optimal; for example, high-performance or low-level work with
tree sequences. Currently, 'RcppTskit' provides a limited set of R
functions because the Python API and 'reticulate' already covers
most needs.
Description: 'Tskit' enables efficient storage, manipulation, and analysis
of ancestral recombination graphs (ARGs) using succinct tree sequence
encoding. The tree sequence encoding of an ARG is described in Wong et
al. (2024) <doi:10.1093/genetics/iyae100>, while `tskit` project is
described in Jeffrey et al. (2026) <doi:10.48550/arXiv.2602.09649>.
See also <https://tskit.dev> for project news, documentation, and
tutorials. 'Tskit' provides Python, C, and Rust application
programming interfaces (APIs). The Python API can be called from R via
the 'reticulate' package to load and analyse tree sequences as
described at <https://tskit.dev/tutorials/tskitr.html>. 'RcppTskit'
provides R access to the 'tskit' C API for cases where the
'reticulate' option is not optimal; for example, high-performance or
low-level work with tree sequences. Currently, 'RcppTskit' provides a
limited set of R functions because the Python API and 'reticulate'
already covers most needs.
License: MIT + file LICENSE
URL: https://github.com/HighlanderLab/RcppTskit
BugReports: https://github.com/HighlanderLab/RcppTskit/issues
Expand Down
3 changes: 2 additions & 1 deletion RcppTskit/R/RcppTskit-package.R
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@
#' `Tskit` enables efficient storage, manipulation, and analysis of
#' ancestral recombination graphs (ARGs) using succinct tree sequence encoding.
#' The tree sequence encoding of an ARG is described in Wong et al. (2024)
#' <doi:10.1093/genetics/iyae100>.
#' <doi:10.1093/genetics/iyae100>, while `tskit` project is
#' described in Jeffrey et al. (2026) <doi:10.48550/arXiv.2602.09649>.
#' See also https://tskit.dev for project news, documentation, and tutorials.
#' `Tskit` provides Python, C, and Rust application programming interfaces (APIs).
#' The Python API can be called from R via the `reticulate` package to
Expand Down
3 changes: 2 additions & 1 deletion RcppTskit/man/RcppTskit-package.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

28 changes: 15 additions & 13 deletions RcppTskit/vignettes/references.bib
Original file line number Diff line number Diff line change
Expand Up @@ -38,15 +38,15 @@ @article{jeffrey2026population
Bisschop, Gertjan and
Deng, Yun and
Ellerman, E Castedo and
Forest, Thomas and
Forest, B Thomas and
Fritze, Halley and
Goldstein, Daniel and
Gorjanc, Gregor and
Gower, Graham and
Gravel, Simon and
Guez, Jeremy and
Haller, Benjamin C. and
Kern, Andrew D. and
Haller, Benjamin C and
Kern, Andrew D and
Kirk, Lloyd and
Krukov, Ivan and
Lee, Hanbin and
Expand All @@ -55,23 +55,23 @@ @article{jeffrey2026population
Osmond, Matthew M and
Palmer, Duncan S and
Pope, Nathaniel S and
Ragsdale, Aaron and
Ragsdale, Aaron P and
Robertson, Duncan and
Rodrigues, Murillo F and
Weiss, Clemens and
van Kemenade, Hugo and
Weiss, Clemens L and
Wohns, Anthony Wilder and
Zhan, Shing H and
Zhang, Brian and
van Kemenade, Hugo and
Aspbury, Maz and
Baya, Nik and
Zhang, Brian C and
Aspbury, Marianne and
Baya, Nikolas A and
Belsare, Saurabh and
Biddanda, Arjun and
Campuzano, Curro and
Campuzano Jiménez, Francisco and
Gladstein, Ariella and
Guo, Bing and
Karthikeyan, Savita and
Kretzschumar, Warren W and
Kretzschmar, Warren W and
Rebollo, Inés and
Saunack, Kumar and
Shemirani, Ruhollah and
Expand All @@ -83,8 +83,10 @@ @article{jeffrey2026population
Zhang, Ao and
Ralph, Peter
Kelleher, Jerome},
journal = {TODO},
year = {2026}
journal = {arXiv},
year = {2026},
doi = {10.48550/arXiv.2602.09649},
url = {https://arxiv.org/abs/2602.09649}
}

@article{lewanski2024era,
Expand Down
Loading