Skip to content

Commit 74eb76c

Browse files
committed
Improved docs
Fixes #92 #106
1 parent bf4211a commit 74eb76c

2 files changed

Lines changed: 20 additions & 12 deletions

File tree

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ General: [![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-expe
4040

4141
<!-- Row 2 -->
4242
Release: [![CRAN version](https://www.r-pkg.org/badges/version/RcppTskit)](https://CRAN.R-project.org/package=RcppTskit) <!-- Col-1-End -->
43-
[![Downloads - total](https://cranlogs.r-pkg.org/badges/grand-total/RcppTskit)](https://cranlogs.r-pkg.org/badges/grand-total/RcppTskit) <!-- Col-2-End -->
43+
[![Downloads - total](https://cranlogs.r-pkg.org/badges/grand-total/RcppTskit)](https://cranlogs.r-pkg.org/#rpackage) <!-- Col-2-End -->
4444
[![GitHub version (main)](https://img.shields.io/github/r-package/v/HighlanderLab/RcppTskit/main?filename=RcppTskit%2FDESCRIPTION&label=Github)](https://github.com/HighlanderLab/RcppTskit) <!-- Col-3-End -->
4545

4646
<!-- Row 3 -->

‎RcppTskit/vignettes/RcppTskit_intro.qmd‎

Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -23,24 +23,31 @@ If you are new to tree sequences and the broader concept of ancestral
2323
recombination graphs (ARGs),
2424
see @brandt2024promise, @lewanski2024era, @nielsen2024inference, and @wong2024general.
2525
Before showing how to use `RcppTskit`,
26-
we summarise the now extensive tree sequence ecosystem,
27-
because this has shaped the aim and design of `RcppTskit`.
28-
We then highlight the aims of `RcppTskit`,
26+
we highlight the targeted users and
27+
summarise the now extensive tree sequence ecosystem,
28+
as this has shaped the aim and design of `RcppTskit`.
29+
We then describe specific aims of `RcppTskit`,
2930
describe the implemented data and class model, and
3031
show four typical use cases.
3132

33+
## Who is `RcppTskit` for?
34+
3235
As summarised below,
3336
`Python` is the most widely used environment for working with tree sequences.
34-
Using the `R` package `reticulate` [@ushey2025reticulate]
35-
<https://rstudio.github.io/reticulate/>,
36-
most `R` users can and should leverage the large ecosystem of `Python` packages,
37-
in particular the popular `tskit Python` API
37+
Most `R` users who want to work with tree sequences
38+
are advised to start with the `tskit Python` API via
39+
the `R` package `reticulate` [@ushey2025reticulate]
40+
<https://rstudio.github.io/reticulate/>.
41+
See <https://tskit.dev/tutorials/tskitr.html>
42+
for a tutorial.
43+
This approach provides access to the most complete and mature API
3844
[@jeffrey2026population]
39-
<https://tskit.dev/tskit/docs/stable/python-api.html>.
40-
With this in mind,
45+
<https://tskit.dev/tskit/docs/stable/python-api.html>
46+
and interoperability with other `Python` packages.
47+
4148
`RcppTskit` is primarily geared towards providing `R` access to the `tskit C` API
4249
[@jeffrey2026population],
43-
for cases where the `reticulate` option is not optimal;
50+
for cases where the `reticulate` approach is not optimal;
4451
for example, high-performance or low-level work with tree sequences.
4552
As a result, `RcppTskit` currently provides a limited set of functions
4653
because the `Python` API (and `reticulate`) already covers most needs.
@@ -115,7 +122,8 @@ with comprehensive packages for simulation and analysis.
115122
There is interest in working with tree sequences in `R`.
116123
Because we can call `Python` from within `R` using the `reticulate R` package,
117124
there is no pressing need for a dedicated `R` API for work with tree sequences.
118-
See <https://tskit.dev/tutorials/tskitr.html> for an example of this approach.
125+
As noted above, see <https://tskit.dev/tutorials/tskitr.html>
126+
for an example of this approach.
119127
This keeps the community focused on the `Python` collection of packages.
120128
While there are differences between `Python` and `R`,
121129
many `R` users should be able to follow

0 commit comments

Comments
 (0)