Skip to content

Commit

Permalink
update readme, news, cran comments for release
Browse files Browse the repository at this point in the history
  • Loading branch information
gmweaver committed Jul 9, 2024
1 parent b64af2a commit 36509d3
Show file tree
Hide file tree
Showing 6 changed files with 14 additions and 11 deletions.
1 change: 1 addition & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,4 @@ cran-comments.md
^docs$
^pkgdown$
^codecov\.yml$
^cran-comments\.md$
8 changes: 8 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
# xrnet 1.0.0

* Changes minimum supported R version 4.0.

* Removes C++11 in SystemRequirements since it is guaranteed that R >= 4.0 that C++11 is minimum supported compiler. This also enables removing CXX_STD=CXX11 in Makevars and Makevars.win.

* Fixes gcc-UBSAN errors detected in latest Rdevel checks. Note that these errors do not impact solutions. They occur when no external data matrix is provided and the underlying C++ code attempts to created a mapped matrix with a pointer to an empty matrix. Since the external data matrix is never used in this case, the resulting standard regularized regression with no external data still produces a correct solution.

# xrnet 0.1.7

* Patched release to fix tests on Solaris OS and removed test dependency on glmnet
Expand Down
2 changes: 1 addition & 1 deletion README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ install.packages("xrnet")
1. OS-specific prerequisites
+ *Windows*: Install [RTools](https://cran.r-project.org/bin/windows/Rtools/) (not an R package)
+ *Mac*: Verify your GNU Fortran version is >= 6.1. If you have an older version, go [here](https://cran.r-project.org/bin/macosx/tools/) to install the required version.
2. Install the R package [devtools](https://github.com/hadley/devtools)
2. Install the R package [devtools](https://github.com/r-lib/devtools)
3. Install the **xrnet** package with the *install_github()* function (optionally install potentially unstable development branch)

```{r, eval = FALSE}
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ install.packages("xrnet")
older version, go
[here](https://cran.r-project.org/bin/macosx/tools/) to install
the required version.
2. Install the R package [devtools](https://github.com/hadley/devtools)
2. Install the R package [devtools](https://github.com/r-lib/devtools)
3. Install the **xrnet** package with the *install_github()* function
(optionally install potentially unstable development branch)

Expand Down
11 changes: 2 additions & 9 deletions cran-comments.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,5 @@
## Submission

This is a patch to fix the test errors generated on Solaris OS.
This is a major release that fixes gcc-UBSAN errors recently detected in r-devel and changes the minimum R version to be >= 4.0.

* Checks reran on all other platforms as well

* The test errors were due to incorrect comparison solutions being generated by another R package on Solaris.
I now pre-generate comparison solutions and have removed the dependency on the other R package previously
used to generate the comparisons. The changes did not require any modifications to the src code.

* Removed glmnet from 'Suggests' in Description as package is no longer needed for tests. This allowed
for the minimum R version to be changed from 3.6 back down to 3.5 to accomodate the old release as well.
* Checks reran on all other platforms as well Rdevel to verify gcc-UBSAN errors were fixed for the case where we try to create a mapped matrix via a pointer to and empty matrix. The mapped matrix is now correctly created in the case the input is an empty matrix.
1 change: 1 addition & 0 deletions revdep/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@ checks.noindex
library.noindex
data.sqlite
*.html
cloud.noindex

0 comments on commit 36509d3

Please sign in to comment.