From a24c060fdd6742e46d393b4604715b60077ada28 Mon Sep 17 00:00:00 2001 From: Henrik Bengtsson Date: Fri, 12 Apr 2024 12:15:17 -0700 Subject: [PATCH 1/4] future.mirai 0.2.0 --- DESCRIPTION | 2 +- NEWS.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index d7d8a7b..a5497cb 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,5 +1,5 @@ Package: future.mirai -Version: 0.1.1-9020 +Version: 0.2.0 Depends: future Imports: diff --git a/NEWS.md b/NEWS.md index 5e61cbb..297ef5c 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,6 +1,6 @@ -# Version (development version) +# Version 0.2.0 - * ... + * First public release. # Version 0.1.1 From faa5c17273e55f597231773067d0f60dfd26942d Mon Sep 17 00:00:00 2001 From: Henrik Bengtsson Date: Fri, 12 Apr 2024 11:51:44 -0700 Subject: [PATCH 2/4] Add CRAN comments --- README.md | 35 ++++++++++++++++++++--------------- cran-comments.md | 26 ++++++++++++++++++++++++++ 2 files changed, 46 insertions(+), 15 deletions(-) create mode 100644 cran-comments.md diff --git a/README.md b/README.md index 9b41ce6..cddee37 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,3 @@ - -
R CMD check status future.tests checks status Coverage Status
@@ -85,7 +83,7 @@ plan(mirai_multisession) demo("mandelbrot", package = "future", ask = FALSE) ``` -and +To use `mirai_cluster` futures, use: ```r library(future.mirai) @@ -96,27 +94,34 @@ demo("mandelbrot", package = "future", ask = FALSE) ``` -[mirai]: https://cran.r-project.org/package=mirai -[future]: https://cran.r-project.org/package=future -[future.mirai]: https://github.com/HenrikBengtsson/future.mirai -[future.apply]: https://cran.r-project.org/package=future.apply -[furrr]: https://cran.r-project.org/package=furrr -[doFuture]: https://cran.r-project.org/package=doFuture - ## Installation -R package future.mirai is only available via [GitHub](https://github.com/HenrikBengtsson/future.mirai) and can be installed in R as: + +R package **future.mirai** is available on +[CRAN](https://cran.r-project.org/package=future.mirai) and can be +installed in R as: + ```r -remotes::install_github("HenrikBengtsson/future.mirai", ref="master") +install.packages("future.mirai") ``` ### Pre-release version -To install the pre-release version that is available in Git branch `develop` on GitHub, use: +To install the pre-release version that is available in Git branch +`develop` on GitHub, use: + ```r remotes::install_github("HenrikBengtsson/future.mirai", ref="develop") ``` -This will install the package from source. - +This will install the package from source. + +[mirai]: https://cran.r-project.org/package=mirai +[future]: https://cran.r-project.org/package=future +[future.mirai]: https://github.com/HenrikBengtsson/future.mirai +[future.apply]: https://cran.r-project.org/package=future.apply +[furrr]: https://cran.r-project.org/package=furrr +[doFuture]: https://cran.r-project.org/package=doFuture + + diff --git a/cran-comments.md b/cran-comments.md new file mode 100644 index 0000000..d99ec79 --- /dev/null +++ b/cran-comments.md @@ -0,0 +1,26 @@ +# CRAN submission future.mirai 0.2.0 + +on 2024-04-12 + +This is a new package. + +I'm using the same terminology, nomenclature and formatting in the package title and description that I use for other closely related "sibling" packages on CRAN, e.g. future.batchtools and future.callr. + +Thanks in advance + + +## Notes not sent to CRAN + +### R CMD check validation + +The package has been verified using `R CMD check --as-cran` on: + +| R version | GitHub | mac/win-builder | +| --------- | ------ | --------------- | +| 3.6.x | L | | +| 4.2.x | L W | W | +| 4.3.x | L M W | M1 W | +| 4.4.x | | W | +| devel | L M W | | + +*Legend: OS: L = Linux, M = macOS, M1 = macOS M1, W = Windows* From f1a06d2bdac170ac071539868a72b90dec6f8370 Mon Sep 17 00:00:00 2001 From: Henrik Bengtsson Date: Fri, 12 Apr 2024 12:27:00 -0700 Subject: [PATCH 3/4] backends -> back-ends trying to avoid 'possibly misspelled words' on CRAN incoming --- DESCRIPTION | 2 +- cran-comments.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index a5497cb..16f54eb 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -11,7 +11,7 @@ Suggests: future.apply, listenv Title: A Future API for Parallel Processing using 'mirai' -Description: Implementation of the Future API on top of the 'mirai' package. This allows you to process futures, as defined by the 'future' package, in parallel out of the box, on your local machine or across remote machines. Contrary to backend frameworks relying on the 'parallel' package (e.g. 'future::multisession') and socket connections, 'mirai_cluster' and 'mirai_multisession', provided here, can run more than 125 parallel R processes. +Description: Implementation of the Future API on top of the 'mirai' package. This allows you to process futures, as defined by the 'future' package, in parallel out of the box, on your local machine or across remote machines. Contrary to back-ends relying on the 'parallel' package (e.g. 'multisession') and socket connections, 'mirai_cluster' and 'mirai_multisession', provided here, can run more than 125 parallel R processes. Authors@R: c( person("Henrik", "Bengtsson", role = c("aut", "cre", "cph"), diff --git a/cran-comments.md b/cran-comments.md index d99ec79..9225ed8 100644 --- a/cran-comments.md +++ b/cran-comments.md @@ -19,7 +19,7 @@ The package has been verified using `R CMD check --as-cran` on: | --------- | ------ | --------------- | | 3.6.x | L | | | 4.2.x | L W | W | -| 4.3.x | L M W | M1 W | +| 4.3.x | L M W | . W | | 4.4.x | | W | | devel | L M W | | From 2c93986c71c810eb87f91a05bae4998e96ffde30 Mon Sep 17 00:00:00 2001 From: Henrik Bengtsson Date: Thu, 18 Apr 2024 12:14:17 -0700 Subject: [PATCH 4/4] Update package title and description according to CRAN newbie review feedback --- DESCRIPTION | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 16f54eb..9bc82d8 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -10,8 +10,8 @@ Suggests: future.tests, future.apply, listenv -Title: A Future API for Parallel Processing using 'mirai' -Description: Implementation of the Future API on top of the 'mirai' package. This allows you to process futures, as defined by the 'future' package, in parallel out of the box, on your local machine or across remote machines. Contrary to back-ends relying on the 'parallel' package (e.g. 'multisession') and socket connections, 'mirai_cluster' and 'mirai_multisession', provided here, can run more than 125 parallel R processes. +Title: A 'Future' API for Parallel Processing using 'mirai' +Description: Implementation of the 'Future' API on top of the 'mirai' package. This allows you to process futures, as defined by the 'future' package, in parallel out of the box, on your local machine or across remote machines. Contrary to back-ends relying on the 'parallel' package (e.g. 'multisession') and socket connections, 'mirai_cluster' and 'mirai_multisession', provided here, can run more than 125 parallel R processes. Authors@R: c( person("Henrik", "Bengtsson", role = c("aut", "cre", "cph"),