Skip to content

Commit 90a41d7

Browse files
committed
Update cran-comments and bits
1 parent 4fd037a commit 90a41d7

5 files changed

Lines changed: 32 additions & 16 deletions

File tree

.gitignore

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
.Ruserdata
66
.vscode
77
*.Rproj
8+
cran-comments.html
9+
cran-comments_files/
810
RcppTskit/**/.quarto/
911
RcppTskit/inst/doc
1012
RcppTskit/src/*.o
@@ -15,5 +17,5 @@ RcppTskit/src/Makevars
1517
RcppTskit/src/Makevars.win
1618
RcppTskit/vignettes/*.html
1719
RcppTskit/vignettes/*.R
18-
RcppTskit/vignettes/*_files
20+
RcppTskit/vignettes/*_files/
1921
test.trees

RcppTskit/.Rbuildignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@
1111
^\.github$
1212
^codecov\.yaml$
1313
^cran-comments\.md$
14+
^cran-comments\.html$
15+
^cran-comments_files$
1416
^inst/examples/create_test\.trees\.R$
1517
^inst/examples/create_test\.trees\.py$
1618
^inst/examples/explore_reticulate\.R$

RcppTskit/NEWS.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This is the first release.
1010

1111
### Added (new features)
1212

13-
- Initial version of RcppTskit using the tskit C API (version 1.3.0).
13+
- Initial version of RcppTskit using the tskit C API (1.3.0).
1414
- TreeSequence R6 class so R code looks Pythonic.
1515
- `ts_load()` or `TreeSequence$new()` to load a tree sequence from file into R.
1616
- Methods to summarise a tree sequence and its contents `ts$print()`,
@@ -19,5 +19,5 @@ This is the first release.
1919
- Method to push tree sequence between R and reticulate Python
2020
`ts$r_to_py()` and `ts_py_to_r()`.
2121
- Most methods have an underlying (unexported) C++ function that works with
22-
a pointer to tree sequence object,for example, `RcppTskit:::ts_load_ptr()`.
22+
a pointer to tree sequence object, for example, `RcppTskit:::ts_load_ptr()`.
2323
- All implemented functionality is documented and demonstrated with a vignette.

RcppTskit/cran-comments.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,27 @@
33
0 errors | 0 warnings | 1 note
44

55
* This is a new release.
6+
7+
* I have tested on my local MacOS laptop using:
8+
`devtools::check()` and
9+
`devtools::check(remote = TRUE, manual = TRUE)`. Both pass.
10+
11+
* I have also used R CMD check GitHub action on MacOS, Windows, and
12+
Ubunutu (olderelease, release, and devel, and ); all pass as you can
13+
see at https://github.com/HighlanderLab/RcppTskit/actions/runs/21542139159.
14+
15+
* `urlchecker::url_check()` also passes.
16+
17+
* On https://win-builder.r-project.org/UmBp28nqBAkU/00check.log
18+
I get this warning:
19+
20+
```
21+
* checking whether package 'RcppTskit' can be installed ... WARNING
22+
Found the following significant warnings:
23+
../inst/include/tskit/tskit/core.h:171:21: warning: C++ designated initializers only available with '-std=c++20' or '-std=gnu++20' [-Wc++20-extensions]
24+
```
25+
26+
Discussion with upstream devs of tskit indicates that this is due
27+
to how the build tools have been built for this platform since
28+
we could not replicate the warning on any of our platforms even when
29+
tweaking the flags - see https://github.com/tskit-dev/tskit/issues/3375.

RcppTskit/notes_pkg_dev.Rmd

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@
55
# TODO: Create a minimal package to demonstrate how to link against RcppTskit and call tskit C API
66
https://github.com/HighlanderLab/RcppTskit/issues/48
77

8-
9-
108
TODO: Add citation for tskit to DESCRIPTION file #46
119
https://github.com/HighlanderLab/RcppTskit/issues/46
1210

@@ -15,13 +13,6 @@ TODO: Add citation for tskit to DESCRIPTION file #46
1513
# https://github.com/HighlanderLab/RcppTskit/issues/15
1614
# remotes::install_github("HighlanderLab/RcppTskit/RcppTskit")
1715

18-
# Main branch
19-
remotes::install_github("HighlanderLab/RcppTskit/RcppTskit")
20-
21-
# TODO: Create a devel branch #16
22-
# https://github.com/HighlanderLab/RcppTskit/issues/16
23-
# remotes::install_github("HighlanderLab/RcppTskit/RcppTskit@devel")
24-
2516
# TODO: Publish on CRAN #14
2617
# https://github.com/HighlanderLab/RcppTskit/issues/14
2718

@@ -150,10 +141,7 @@ PATCH version when you make backward compatible bug fixes
150141
```
151142
use_upkeep_issue(year = NULL) # https://usethis.r-lib.org/reference/use_upkeep_issue.html
152143
use_release_issue(version = NULL) # https://usethis.r-lib.org/reference/use_release_issue.html
153-
use_cran_comments() # https://usethis.r-lib.org/reference/use_cran_comments.html
154-
use_github_release(publish = TRUE) # https://usethis.r-lib.org/reference/use_github_release.html
155-
devtools::release(pkg = ".", check = TRUE)
156-
# pkg The package to use, can be a file path to the package or a package object. See as.package() for more information
144+
# just follow tasks in there;)
157145
```
158146

159147
## Setup

0 commit comments

Comments
 (0)