@@ -23,24 +23,31 @@ If you are new to tree sequences and the broader concept of ancestral
2323recombination graphs (ARGs),
2424see @brandt2024promise , @lewanski2024era , @nielsen2024inference , and @wong2024general .
2525Before 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 ` ,
2930describe the implemented data and class model, and
3031show four typical use cases.
3132
33+ ## Who is ` RcppTskit ` for?
34+
3235As 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;
4451for example, high-performance or low-level work with tree sequences.
4552As a result, ` RcppTskit ` currently provides a limited set of functions
4653because the ` Python ` API (and ` reticulate ` ) already covers most needs.
@@ -115,7 +122,8 @@ with comprehensive packages for simulation and analysis.
115122There is interest in working with tree sequences in ` R ` .
116123Because we can call ` Python ` from within ` R ` using the ` reticulate R ` package,
117124there 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.
119127This keeps the community focused on the ` Python ` collection of packages.
120128While there are differences between ` Python ` and ` R ` ,
121129many ` R ` users should be able to follow
0 commit comments