Touch up RcppEnsmallen build for new CRAN requirements (#58)

* Fix URLs (HTTP -> HTTPS) * Update authors * Fix citation * Add changelog entries * citEntry() -> bibentry()
coatless-rpkg · Oct 6, 2023 · 0ea9961 · 0ea9961
1 parent 84ef62f
commit 0ea9961
Show file tree

Hide file tree

Showing 9 changed files with 28 additions and 20 deletions.
diff --git a/ChangeLog b/ChangeLog
@@ -1,8 +1,12 @@
 2023-10-05  James Balamuta  <balamut2@illinois.edu>
 
+	* NEWS.md: Fixed redirected HTTP to HTTPS urls
+	* DESCRIPTION: ditto
+	* vignettes/using-rcppensmallen.Rmd: ditto
+
 	* NEWS.md: Restored mlpack/ensmallen URLs
 
-	* DESCRIPTION: Removed CXX11 requirement
+	* DESCRIPTION: Removed CXX11 requirement and bumped R version required to 4.0
 	* src/Makevars: ditto
 	* src/Makevars.win: ditto
 

diff --git a/DESCRIPTION b/DESCRIPTION
@@ -23,9 +23,9 @@ Description: 'Ensmallen' is a templated C++ mathematical optimization library
  the GNU GPL version 2 or later. Thus, 'RcppEnsmallen' is also licensed under
  similar terms. Note that 'Ensmallen' requires a compiler that supports 
  'C++11' and 'Armadillo' 9.800 or later.
-Depends: R (>= 3.3.0)
+Depends: R (>= 4.0.0)
 License: GPL (>= 2)
-URL: https://github.com/coatless-rpkg/rcppensmallen, https://github.com/mlpack/ensmallen, http://ensmallen.org/
+URL: https://github.com/coatless-rpkg/rcppensmallen, https://github.com/mlpack/ensmallen, https://ensmallen.org/
 BugReports: https://github.com/coatless-rpkg/rcppensmallen/issues
 Encoding: UTF-8
 LinkingTo: Rcpp, RcppArmadillo (>= 0.9.800.0.0)

diff --git a/NEWS.md b/NEWS.md
@@ -10,16 +10,18 @@
   - Rename `SCD` optimizer, to `CD`
     ([#379](https://github.com/mlpack/ensmallen/pull/379)).
 - Updated GitHub Action runners `update-ensmallen-refresh` and `pkgdown` to address deprecation notices.
-    ([#53](https://github.com/coatless-rpkg/rcppensmallen/53), [#54](https://github.com/coatless-rpkg/rcppensmallen/54), [#55](https://github.com/coatless-rpkg/rcppensmallen/55)).
+    ([#53](https://github.com/coatless-rpkg/rcppensmallen/pull/53), [#54](https://github.com/coatless-rpkg/rcppensmallen/pull/54), [#55](https://github.com/coatless-rpkg/rcppensmallen/pull/55)).
 - Removed explicit C++11 requirement from `DESCRIPTION` and `Makevars{.win}`.
+- Increased the R version required to R 4.0 to ensure a compiler with
+  C++11 is available.
 
 # RcppEnsmallen 0.2.19.1.1
 
 - Upgraded to ensmallen 2.19.1: "Eight Ball Deluxe" (2023-02-08)
  - Avoid deprecation warnings in Armadillo 11.2+
     ([#347](https://github.com/mlpack/ensmallen/pull/347)).
 - Updated GitHub Action's runner to the latest versions 
-    ([#51](https://github.com/coatless-rpkg/rcppensmallen/51)).
+    ([#51](https://github.com/coatless-rpkg/rcppensmallen/pull/51)).
 
 # RcppEnsmallen 0.2.19.0.1
 
@@ -345,7 +347,7 @@
 ## New
 
 - Support for compiling via _R_ the mathematical optimizers in the _C++_
-  [ensmallen](http://ensmallen.org/docs.html) library.
+  [ensmallen](https://ensmallen.org/docs.html) library.
 - Includes ensmallen release 1.10.0 "Corporate Catabolism" (2018-10-19)
 
 ## Special Thanks

diff --git a/README.md b/README.md
@@ -18,7 +18,7 @@ gradient-free optimizers, and constrained optimization.
 
 The RcppEnsmallen package includes the header files from the Ensmallen library
 and pairs the appropriate header files from 
-[Armadillo](http://arma.sourceforge.net/) through the 
+[Armadillo](https://arma.sourceforge.net/) through the 
 [RcppArmadillo](https://cran.r-project.org/package=RcppArmadillo) package. 
 Therefore, users do not need to install Ensmallen nor Armadillo to use RcppEnsmallen. 
 

diff --git a/inst/AUTHORS b/inst/AUTHORS
@@ -33,6 +33,7 @@ file:
   Copyright 2019, Rahul Ganesh Prabhu
   Copyright 2019, Roberto Hueso <robertohueso96@gmail.com>
   Copyright 2019, Sayan Goswami <sayan.goswami.106@gmail.com>
+  Copyright 2020, Joe Dinius <josephwdinius@gmail.com>
 
 The RcppEnsmallen package provides an integration of Ensmallen and its dependences
 into R. RcppEnsmallen accomplishes this by linking into RcppArmadillo,

diff --git a/inst/CITATION b/inst/CITATION
@@ -1,23 +1,23 @@
 citHeader("To cite the 'RcppEnsmallen' R package and 'Ensmallen' libray in publications, please use:")
 
-citEntry(entry = "Manual",
+bibentry(bibtype = "Manual",
          title        = "{RcppEnsmallen: Header-Only C++ Mathematical Optimization Library for 'Armadillo'}",
-         author       = personList(as.person("James Joseph Balamuta"),
-                                   as.person("Dirk Eddelbuettel")
-                                  ),
+         author       = c(as.person("James Joseph Balamuta"),
+                          as.person("Dirk Eddelbuettel")
+                          ),
          year         = 2018,
          textVersion  = paste("Balamuta, J.J. and Eddelbuettel, D. (2018)",
                               "RcppEnsmallen: Header-Only C++ Mathematical Optimization Library for 'Armadillo'.",
                               "URL https://cran.r-project.org/package=RcppEnsmallen.")
 )
 
-citEntry(entry = "Article",
+bibentry(bibtype = "Article",
          title        = "{ensmallen: a flexible C++ library for efficient function optimization}",
-         author       = personList(as.person("Shikhar Bhardwaj"),
-                                   as.person("Ryan R. Curtin"),
-                                   as.person("Marcus Edel"),
-                                   as.person("Yannis Mentekidis"),
-                                   as.person("Conrad Sanderson")),
+         author       = c(as.person("Shikhar Bhardwaj"),
+                          as.person("Ryan R. Curtin"),
+                          as.person("Marcus Edel"),
+                          as.person("Yannis Mentekidis"),
+                          as.person("Conrad Sanderson")),
            journal = "Workshop on Systems for ML and Open Source Software at NIPS",
            year = "2018",
            month = "dec",

diff --git a/inst/COPYRIGHTS b/inst/COPYRIGHTS
@@ -48,6 +48,7 @@ Copyright:
   Copyright 2019, Rahul Ganesh Prabhu
   Copyright 2019, Roberto Hueso <robertohueso96@gmail.com>
   Copyright 2019, Sayan Goswami <sayan.goswami.106@gmail.com>
+  Copyright 2020, Joe Dinius <josephwdinius@gmail.com>
 
 License: BSD-3-clause
   All rights reserved.

diff --git a/man/RcppEnsmallen-package.Rd b/man/RcppEnsmallen-package.Rd
diff --git a/vignettes/using-rcppensmallen.Rmd b/vignettes/using-rcppensmallen.Rmd
@@ -31,8 +31,8 @@ Alternatively, work has been done by Dirk Schumacher in
 [`armacmp`](https://github.com/dirkschumacher/armacmp) to automatically create
 the underlying _C++_ code from _R_.  
 
-**Note:** Optimizers in `RcppEnsmallen` only work with [`armadillo`](http://arma.sourceforge.net/docs.html)
-data structures. Thus, if using [`Eigen`](http://eigen.tuxfamily.org/index.php?title=Main_Page) through 
+**Note:** Optimizers in `RcppEnsmallen` only work with [`armadillo`](https://arma.sourceforge.net/docs.html)
+data structures. Thus, if using [`Eigen`](https://eigen.tuxfamily.org/index.php?title=Main_Page) through 
 [`RcppEigen`](https://cran.r-project.org/package=RcppEigen), please consider the 
 [`RcppNumerical`](https://cran.r-project.org/package=RcppNumerical)
 package.