Skip to content

Commit abab946

Browse files
committed
Edit DESCRIPTION based on CRAN comments
1 parent 6131a63 commit abab946

6 files changed

Lines changed: 46 additions & 27 deletions

File tree

RcppTskit/DESCRIPTION

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Type: Package
22
Package: RcppTskit
3-
Title: R Access to the Tskit C API
3+
Title: 'R' Access to the 'tskit C' API
44
Version: 0.2.0
55
Date: 2026-01-27
66
Authors@R: c(
@@ -15,14 +15,14 @@ Description: 'Tskit' enables efficient storage, manipulation, and analysis
1515
al. (2024) <doi:10.1093/genetics/iyae100>, while `tskit` project is
1616
described in Jeffrey et al. (2026) <doi:10.48550/arXiv.2602.09649>.
1717
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
18+
tutorials. 'Tskit' provides 'Python', 'C', and 'Rust' application
19+
programming interfaces (APIs). The 'Python' API can be called from 'R' via
2020
the 'reticulate' package to load and analyse tree sequences as
2121
described at <https://tskit.dev/tutorials/tskitr.html>. 'RcppTskit'
22-
provides R access to the 'tskit' C API for cases where the
22+
provides 'R' access to the 'tskit C' API for cases where the
2323
'reticulate' option is not optimal; for example, high-performance or
2424
low-level work with tree sequences. Currently, 'RcppTskit' provides a
25-
limited set of R functions because the Python API and 'reticulate'
25+
limited set of 'R' functions because the 'Python' API and 'reticulate'
2626
already covers most needs.
2727
License: MIT + file LICENSE
2828
URL: https://github.com/HighlanderLab/RcppTskit

RcppTskit/NEWS.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ All notable changes to RcppTskit are documented in this file.
44
The file format is based on [Keep a Changelog](https://keepachangelog.com),
55
and releases adhere to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
66

7-
## [0.2.0] - 2026-02-09
7+
## [0.2.0] - 2026-02-13
88

99
### Added (new features)
1010

@@ -33,6 +33,10 @@ and releases adhere to [Semantic Versioning](https://semver.org/spec/v2.0.0.html
3333
- We now specify C++20 standard to go around the CRAN Windows issue,
3434
see #63 for further details.
3535

36+
### Maintenance
37+
38+
- Delete temporary files in examples and tests after use.
39+
3640
- Renamed unexported functions from `RcppTskit:::ts_load_ptr()` to
3741
`RcppTskit:::ts_ptr_load()`.
3842

RcppTskit/R/RcppTskit-package.R

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,27 @@
11
# Contains the package description and .onLoad() function
22

33
#' @description
4-
#' `Tskit` enables efficient storage, manipulation, and analysis of
4+
#' \code{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>, while `tskit` project is
7+
#' <doi:10.1093/genetics/iyae100>, while \code{tskit} project is
88
#' described in Jeffrey et al. (2026) <doi:10.48550/arXiv.2602.09649>.
99
#' 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
1212
#' load and analyse tree sequences as described at
1313
#' 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.
1818
#' @keywords internal
1919
#'
2020
#' @useDynLib RcppTskit, .registration = TRUE
2121
#' @importFrom methods is
2222
#' @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
2525
#'
2626
#' @examples
2727
#' vignette(package="RcppTskit")
@@ -32,7 +32,7 @@
3232
#' (search for cppFunction).
3333
#
3434
#' 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
3636
#' include paths but there is no library to link against. RcppTskit is different
3737
#' because we must link against the compiled RcppTskit library file. The plugin
3838
#' (or `PKG_LIBS`) provides linker flags in addition to `depends` for include

RcppTskit/cran-comments.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,20 @@
44

55
* This is a new release (v0.2.0).
66

7+
* Re-submitting to CRAN.
8+
9+
* Submitted to CRAN on 2026-02-09 and got feedback to quote
10+
Python, C, and Rust and to be mindful about case sensitivity.
11+
12+
I assume the case sensitivity refers to the use of
13+
`Tskit` and `tskit`. I am following the convention from
14+
https://tskit.dev to use 'Tskit' at the start of sentences and
15+
'tskit' otherwise. I am also following the guidance from
16+
the R packages manual & CRAN cookbook to quote program/package name.
17+
18+
We now also quote Python, C, and Rust (also R for consistency)
19+
in the DESCRIPTION file.
20+
721
* It passes checks on my local MacOS laptop using:
822
`devtools::check()` and
923
`devtools::check(remote = TRUE, manual = TRUE)`.
@@ -25,7 +39,7 @@
2539
```
2640

2741
I have now addressed it by setting CXX_STD = CXX20 in Makevars.in.
28-
Note that discussion with upstream devs of tskit indicates that this warning
42+
Note that discussion with upstream devs of `tskit` indicates that this warning
2943
seems to arise from how the build tools have been built for CRAN windows,
3044
since we could not replicate the warning on any of platforms even when
3145
tweaking the flags, including Windows. See the above checks and

RcppTskit/man/RcppTskit-package.Rd

Lines changed: 9 additions & 9 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

RcppTskit/notes_pkg_dev.Rmd

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,7 @@ PATCH version when you make backward compatible bug fixes
106106
### Removed (now removed features)
107107
### Fixed (bug fixes)
108108
### Security (vulnerabilities)
109+
### Maintenance (non-user facing changes, e.g. refactoring, CI updates, etc.)
109110
```
110111

111112
## Prepare for release

0 commit comments

Comments
 (0)