|
1 | 1 | # Contains the package description and .onLoad() function |
2 | 2 |
|
3 | 3 | #' @description |
4 | | -#' `Tskit` enables efficient storage, manipulation, and analysis of |
| 4 | +#' \code{Tskit} enables efficient storage, manipulation, and analysis of |
5 | 5 | #' ancestral recombination graphs (ARGs) using succinct tree sequence encoding. |
6 | 6 | #' The tree sequence encoding of an ARG is described in Wong et al. (2024) |
7 | | -#' <doi:10.1093/genetics/iyae100>, while `tskit` project is |
| 7 | +#' <doi:10.1093/genetics/iyae100>, while \code{tskit} project is |
8 | 8 | #' described in Jeffrey et al. (2026) <doi:10.48550/arXiv.2602.09649>. |
9 | 9 | #' See also https://tskit.dev for project news, documentation, and tutorials. |
10 | | -#' `Tskit` provides Python, C, and Rust application programming interfaces (APIs). |
11 | | -#' The Python API can be called from R via the `reticulate` package to |
| 10 | +#' \code{Tskit} provides Python, C, and Rust application programming interfaces (APIs). |
| 11 | +#' The Python API can be called from R via the \code{reticulate} package to |
12 | 12 | #' load and analyse tree sequences as described at |
13 | 13 | #' https://tskit.dev/tutorials/tskitr.html. |
14 | | -#' `RcppTskit` provides R access to the `tskit` C API for cases where the |
15 | | -#' `reticulate` option is not optimal; for example; high-performance or low-level |
16 | | -#' work with tree sequences. Currently, `RcppTskit` provides a limited set of |
17 | | -#' R functions because the Python API and `reticulate` already covers most needs. |
| 14 | +#' \code{RcppTskit} provides R access to the \code{tskit} C API for cases where the |
| 15 | +#' \code{reticulate} option is not optimal; for example; high-performance or low-level |
| 16 | +#' work with tree sequences. Currently, \code{RcppTskit} provides a limited set of |
| 17 | +#' R functions because the Python API and \code{reticulate} already covers most needs. |
18 | 18 | #' @keywords internal |
19 | 19 | #' |
20 | 20 | #' @useDynLib RcppTskit, .registration = TRUE |
21 | 21 | #' @importFrom methods is |
22 | 22 | #' @importFrom R6 R6Class |
23 | | -#' @importFrom Rcpp registerPlugin cppFunction |
24 | | -#' @importFrom reticulate is_py_object import py_module_available py_require |
| 23 | +#' @importFrom Rcpp cppFunction registerPlugin |
| 24 | +#' @importFrom reticulate import is_py_object py_module_available py_require |
25 | 25 | #' |
26 | 26 | #' @examples |
27 | 27 | #' vignette(package="RcppTskit") |
|
32 | 32 | #' (search for cppFunction). |
33 | 33 | # |
34 | 34 | #' In RcppArmadillo, I do not see any use of Rcpp::registerPlugin(). This is |
35 | | -#' likely because Armadillo is header-only, so `depends = "RcppArmadillo"` adds |
| 35 | +#' because Armadillo is header-only, so `depends = "RcppArmadillo"` adds |
36 | 36 | #' include paths but there is no library to link against. RcppTskit is different |
37 | 37 | #' because we must link against the compiled RcppTskit library file. The plugin |
38 | 38 | #' (or `PKG_LIBS`) provides linker flags in addition to `depends` for include |
|
0 commit comments