Merge tag '0.2.0' into develop

future.mirai 0.2.0

DESCRIPTION

@@ -1,5 +1,5 @@
 Package: future.mirai
-Version: 0.1.1-9020
+Version: 0.2.0
 Depends:
     future
 Imports:
@@ -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 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.
+Title: A 'Future' API for Parallel Processing using 'mirai'
+Description: Implementation of the 'Future' API <doi:10.32614/RJ-2021-048> 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"),

NEWS.md

@@ -1,6 +1,6 @@
-# Version (development version)
+# Version 0.2.0
 
- * ...
+ * First public release.
 
 
 # Version 0.1.1

README.md

@@ -1,5 +1,3 @@
-
-
 <div id="badges"><!-- pkgdown markup -->
  <a href="https://github.com/HenrikBengtsson/future.mirai/actions?query=workflow%3AR-CMD-check"><img border="0" src="https://github.com/HenrikBengtsson/future.mirai/actions/workflows/R-CMD-check.yaml/badge.svg?branch=develop" alt="R CMD check status"/></a>  <a href="https://github.com/HenrikBengtsson/future.mirai/actions?query=workflow%3Afuture_tests"><img border="0" src="https://github.com/HenrikBengtsson/future.mirai/actions/workflows/future_tests.yaml/badge.svg?branch=develop" alt="future.tests checks status"/></a>   <a href="https://app.codecov.io/gh/HenrikBengtsson/future.mirai"><img border="0" src="https://codecov.io/gh/HenrikBengtsson/future.mirai/branch/develop/graph/badge.svg" alt="Coverage Status"/></a> 
 </div>
@@ -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.  
 
-<!-- pkgdown-drop-below -->
+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
+
+<!-- pkgdown-drop-below -->

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  |  . W            |
+| 4.4.x     |        |    W            |
+| devel     | L M W  |                 |
+
+*Legend: OS: L = Linux, M = macOS, M1 = macOS M1, W = Windows*