Skip to content

Commit 0ea9961

Browse files
authored
Touch up RcppEnsmallen build for new CRAN requirements (#58)
* Fix URLs (HTTP -> HTTPS) * Update authors * Fix citation * Add changelog entries * citEntry() -> bibentry()
1 parent 84ef62f commit 0ea9961

File tree

9 files changed

+28
-20
lines changed

9 files changed

+28
-20
lines changed

ChangeLog

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
11
2023-10-05 James Balamuta <[email protected]>
22

3+
* NEWS.md: Fixed redirected HTTP to HTTPS urls
4+
* DESCRIPTION: ditto
5+
* vignettes/using-rcppensmallen.Rmd: ditto
6+
37
* NEWS.md: Restored mlpack/ensmallen URLs
48

5-
* DESCRIPTION: Removed CXX11 requirement
9+
* DESCRIPTION: Removed CXX11 requirement and bumped R version required to 4.0
610
* src/Makevars: ditto
711
* src/Makevars.win: ditto
812

DESCRIPTION

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ Description: 'Ensmallen' is a templated C++ mathematical optimization library
2323
the GNU GPL version 2 or later. Thus, 'RcppEnsmallen' is also licensed under
2424
similar terms. Note that 'Ensmallen' requires a compiler that supports
2525
'C++11' and 'Armadillo' 9.800 or later.
26-
Depends: R (>= 3.3.0)
26+
Depends: R (>= 4.0.0)
2727
License: GPL (>= 2)
28-
URL: https://github.com/coatless-rpkg/rcppensmallen, https://github.com/mlpack/ensmallen, http://ensmallen.org/
28+
URL: https://github.com/coatless-rpkg/rcppensmallen, https://github.com/mlpack/ensmallen, https://ensmallen.org/
2929
BugReports: https://github.com/coatless-rpkg/rcppensmallen/issues
3030
Encoding: UTF-8
3131
LinkingTo: Rcpp, RcppArmadillo (>= 0.9.800.0.0)

NEWS.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,18 @@
1010
- Rename `SCD` optimizer, to `CD`
1111
([#379](https://github.com/mlpack/ensmallen/pull/379)).
1212
- Updated GitHub Action runners `update-ensmallen-refresh` and `pkgdown` to address deprecation notices.
13-
([#53](https://github.com/coatless-rpkg/rcppensmallen/53), [#54](https://github.com/coatless-rpkg/rcppensmallen/54), [#55](https://github.com/coatless-rpkg/rcppensmallen/55)).
13+
([#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)).
1414
- Removed explicit C++11 requirement from `DESCRIPTION` and `Makevars{.win}`.
15+
- Increased the R version required to R 4.0 to ensure a compiler with
16+
C++11 is available.
1517

1618
# RcppEnsmallen 0.2.19.1.1
1719

1820
- Upgraded to ensmallen 2.19.1: "Eight Ball Deluxe" (2023-02-08)
1921
- Avoid deprecation warnings in Armadillo 11.2+
2022
([#347](https://github.com/mlpack/ensmallen/pull/347)).
2123
- Updated GitHub Action's runner to the latest versions
22-
([#51](https://github.com/coatless-rpkg/rcppensmallen/51)).
24+
([#51](https://github.com/coatless-rpkg/rcppensmallen/pull/51)).
2325

2426
# RcppEnsmallen 0.2.19.0.1
2527

@@ -345,7 +347,7 @@
345347
## New
346348

347349
- Support for compiling via _R_ the mathematical optimizers in the _C++_
348-
[ensmallen](http://ensmallen.org/docs.html) library.
350+
[ensmallen](https://ensmallen.org/docs.html) library.
349351
- Includes ensmallen release 1.10.0 "Corporate Catabolism" (2018-10-19)
350352

351353
## Special Thanks

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ gradient-free optimizers, and constrained optimization.
1818

1919
The RcppEnsmallen package includes the header files from the Ensmallen library
2020
and pairs the appropriate header files from
21-
[Armadillo](http://arma.sourceforge.net/) through the
21+
[Armadillo](https://arma.sourceforge.net/) through the
2222
[RcppArmadillo](https://cran.r-project.org/package=RcppArmadillo) package.
2323
Therefore, users do not need to install Ensmallen nor Armadillo to use RcppEnsmallen.
2424

inst/AUTHORS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ file:
3333
Copyright 2019, Rahul Ganesh Prabhu
3434
Copyright 2019, Roberto Hueso <[email protected]>
3535
Copyright 2019, Sayan Goswami <[email protected]>
36+
Copyright 2020, Joe Dinius <[email protected]>
3637

3738
The RcppEnsmallen package provides an integration of Ensmallen and its dependences
3839
into R. RcppEnsmallen accomplishes this by linking into RcppArmadillo,

inst/CITATION

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
11
citHeader("To cite the 'RcppEnsmallen' R package and 'Ensmallen' libray in publications, please use:")
22

3-
citEntry(entry = "Manual",
3+
bibentry(bibtype = "Manual",
44
title = "{RcppEnsmallen: Header-Only C++ Mathematical Optimization Library for 'Armadillo'}",
5-
author = personList(as.person("James Joseph Balamuta"),
6-
as.person("Dirk Eddelbuettel")
7-
),
5+
author = c(as.person("James Joseph Balamuta"),
6+
as.person("Dirk Eddelbuettel")
7+
),
88
year = 2018,
99
textVersion = paste("Balamuta, J.J. and Eddelbuettel, D. (2018)",
1010
"RcppEnsmallen: Header-Only C++ Mathematical Optimization Library for 'Armadillo'.",
1111
"URL https://cran.r-project.org/package=RcppEnsmallen.")
1212
)
1313

14-
citEntry(entry = "Article",
14+
bibentry(bibtype = "Article",
1515
title = "{ensmallen: a flexible C++ library for efficient function optimization}",
16-
author = personList(as.person("Shikhar Bhardwaj"),
17-
as.person("Ryan R. Curtin"),
18-
as.person("Marcus Edel"),
19-
as.person("Yannis Mentekidis"),
20-
as.person("Conrad Sanderson")),
16+
author = c(as.person("Shikhar Bhardwaj"),
17+
as.person("Ryan R. Curtin"),
18+
as.person("Marcus Edel"),
19+
as.person("Yannis Mentekidis"),
20+
as.person("Conrad Sanderson")),
2121
journal = "Workshop on Systems for ML and Open Source Software at NIPS",
2222
year = "2018",
2323
month = "dec",

inst/COPYRIGHTS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@ Copyright:
4848
Copyright 2019, Rahul Ganesh Prabhu
4949
Copyright 2019, Roberto Hueso <[email protected]>
5050
Copyright 2019, Sayan Goswami <[email protected]>
51+
Copyright 2020, Joe Dinius <[email protected]>
5152

5253
License: BSD-3-clause
5354
All rights reserved.

man/RcppEnsmallen-package.Rd

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

vignettes/using-rcppensmallen.Rmd

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ Alternatively, work has been done by Dirk Schumacher in
3131
[`armacmp`](https://github.com/dirkschumacher/armacmp) to automatically create
3232
the underlying _C++_ code from _R_.
3333

34-
**Note:** Optimizers in `RcppEnsmallen` only work with [`armadillo`](http://arma.sourceforge.net/docs.html)
35-
data structures. Thus, if using [`Eigen`](http://eigen.tuxfamily.org/index.php?title=Main_Page) through
34+
**Note:** Optimizers in `RcppEnsmallen` only work with [`armadillo`](https://arma.sourceforge.net/docs.html)
35+
data structures. Thus, if using [`Eigen`](https://eigen.tuxfamily.org/index.php?title=Main_Page) through
3636
[`RcppEigen`](https://cran.r-project.org/package=RcppEigen), please consider the
3737
[`RcppNumerical`](https://cran.r-project.org/package=RcppNumerical)
3838
package.

0 commit comments

Comments
 (0)