spell and grammar corrections [ci skip]

Author: HenrikBengtsson

DESCRIPTION

@@ -1,5 +1,5 @@
 Package: future.batchtools
-Version: 0.21.0-9006
+Version: 0.21.0-9007
 Depends:
     R (>= 3.2.0),
     future (>= 1.58.0)

NEWS.md

@@ -95,7 +95,7 @@
      "shutdown" code resource specifications via character vectors
      `resources[["startup"]]` and `resources[["shutdown"]]`. When
      specified, corresponding lines are injected in the generated job
-     script and the beginning and end, respectively.
+     script at the beginning and end, respectively.
 
    - All built-in template job scripts support a "details" resource
      specification via logical scalar `resources[["details"]]`. If
@@ -131,14 +131,14 @@
    `fs.latency` seconds (default 65 seconds) to give job schedulers
    and any global file system time to write output to file. Now
    **future.batchtools** will no longer wait for such files and only
-   read their content if they exists when checked.
+   read their content if they exist when checked.
 
 ## Deprecated and Defunct
 
  * R option `future.delete` is deprecated. Please use new R option
-   `future.batchtools.delete` instead. For backward compatible
-   reasons, if R option `future.delete` sets option
-   `future.batchtools.delete` when the packages is loaded and the
+   `future.batchtools.delete` instead. For backward compatibility
+   reasons, R option `future.delete` sets option
+   `future.batchtools.delete` when the package is loaded, if the
    latter is not already set. If `future.delete` is FALSE, then
    `future.batchtools.delete` is set to `"never"`.  If `future.delete`
    is TRUE, then `future.batchtools.delete` is set to `"on-success"`.
@@ -149,7 +149,7 @@
 ## Bug Fixes
 
  * Attempts to cancel batchtools futures via `cancel()` would result
-   in "Interruption of futures require a backend implementing the
+   in "Interruption of futures requires a backend implementing the
    FutureBackend API". Until this package implements the new
    FutureBackend API of future (>= 1.40.0), any calls to `cancel()`
    will be silently ignored.
@@ -170,7 +170,7 @@
  * Improved performance of batchtools futures by avoiding re-checking
    the **batchtools** status if the **batchtools** job has already
    been observed to be resolved.  Checking the **batchtools** status
-   is fairly expense, especially since each status check queries a set
+   is fairly expensive, especially since each status check queries a set
    of files on the file system.
 
  * Improved performance of batchtools futures by making the removal of
@@ -189,7 +189,7 @@
  * `R_FUTURE_BATCHTOOLS_*` environment variables are now only read
    when the **future.batchtools** package is loaded, where they set
    the corresponding `future.batchtools*` option.  This is in line
-   with how all packages in the Futureverse works.
+   with how all packages in the Futureverse work.
 
  * Add `nbrOfFreeWorkers()` for batchtools futures.
 
@@ -205,11 +205,11 @@
    `batchtools_multicore` worker.
 
  * `print()` for BatchtoolsFuture now reports on the batchtools
-   configuration file (an R script) and the the batchtools job template
+   configuration file (an R script) and the batchtools job template
    file (a shell script) with info on location, file size, and number
    of lines, if they exist.
 
- * `run()` for BatchtoolsFuture now produce an informative
+ * `run()` for BatchtoolsFuture now produces an informative
    BatchtoolsFutureError in case `batchtools::submitJobs()` fails, for
    instance, due to invalid job-scheduler resource specifications.
 
@@ -261,7 +261,7 @@
 
 ## Significant Changes
 
- * Lazy batchtools futures only creates the internal **batchtools**
+ * Lazy batchtools futures only create the internal **batchtools**
    registry when the future is launched.
 
  * Removed S3 generic functions `await()`, `finished()`, and
@@ -455,9 +455,9 @@
  * The period between each poll of the scheduler to check whether a
    future (job) is finished or not now increases geometrically as a
    function of number of polls.  This lowers the load on the scheduler
-   for long running jobs.
+   for long-running jobs.
 
- * The error message for expired batchtools futures now include the
+ * The error message for expired batchtools futures now includes the
    last few lines of the logged output, which sometimes includes clues
    on why the future expired.  For instance, if a TORQUE/PBS job use
    more than the allocated amount of memory it might be terminated by

R/batchtools_bash.R

@@ -26,7 +26,7 @@ BatchtoolsBashFutureBackend <- function(..., template = "bash", fs.latency = 0.0
 }
 
 
-#' A batchtools bash backend that resolves futures sequentially via a Bash template script
+#' A batchtools Bash backend that resolves futures sequentially via a Bash template script
 #'
 #' The `batchtools_bash` backend was added to illustrate how to write a
 #' custom \pkg{future.batchtools} backend that uses a templated job script.
@@ -41,7 +41,7 @@ BatchtoolsBashFutureBackend <- function(..., template = "bash", fs.latency = 0.0
 #' @param \ldots Not used.
 #'
 #' @details
-#' Batchtools bash futures use \pkg{batchtools} cluster functions
+#' Batchtools Bash futures use \pkg{batchtools} cluster functions
 #' created by [makeClusterFunctionsBash()] and requires that `bash` is
 #' installed on the current machine and the `timeout` command is available.
 #'
@@ -51,7 +51,7 @@ BatchtoolsBashFutureBackend <- function(..., template = "bash", fs.latency = 0.0
 #' system.file("templates", "bash.tmpl", package = "future.batchtools")
 #' ```
 #'
-#' and comprise:
+#' and comprises:
 #'
 #' `r paste(c("\x60\x60\x60bash", readLines("inst/templates/bash.tmpl"), "\x60\x60\x60"), collapse = "\n")`
 #'

R/batchtools_local.R

@@ -1,8 +1,8 @@
-#' batchtools local and interactive futures
+#' Batchtools local and interactive futures
 #'
-#' A batchtools local future is an synchronous uniprocess future that
+#' A batchtools local future is a synchronous uniprocess future that
 #' will be evaluated in a background R session.
-#' A batchtools interactive future is an synchronous uniprocess future
+#' A batchtools interactive future is a synchronous uniprocess future
 #' that will be evaluated in the current R session (and variables will
 #' be assigned to the calling environment rather than to a local one).
 #' Both types of futures will block until the futures are resolved.
@@ -15,7 +15,7 @@
 #' @return An object of class `BatchtoolsUniprocessFuture`.
 #'
 #' @details
-#' batchtools local futures rely on the batchtools backend set up by
+#' Batchtools local futures rely on the batchtools backend set up by
 #' \code{\link[batchtools:makeClusterFunctionsInteractive]{batchtools::makeClusterFunctionsInteractive(external = TRUE)}}
 #' and batchtools interactive futures on the one set up by
 #' [batchtools::makeClusterFunctionsInteractive()].

R/batchtools_lsf.R

@@ -30,7 +30,7 @@ BatchtoolsLsfFutureBackend <- function(...) {
 #' system.file("templates", "lsf.tmpl", package = "future.batchtools")
 #' ```
 #'
-#' and comprise:
+#' and comprises:
 #'
 #' `r paste(c("\x60\x60\x60bash", readLines("inst/templates/lsf.tmpl"), "\x60\x60\x60"), collapse = "\n")`
 #'

R/batchtools_multicore.R

@@ -1,4 +1,4 @@
-#' batchtools multicore futures
+#' Batchtools multicore futures
 #'
 #' A batchtools multicore future is an asynchronous multiprocess
 #' future that will be evaluated in a background R session.\cr
@@ -19,7 +19,7 @@
 #' @return An object of class `BatchtoolsMulticoreFuture`.
 #'
 #' @details
-#' batchtools multicore futures rely on the batchtools backend set
+#' Batchtools multicore futures rely on the batchtools backend set
 #' up by [batchtools::makeClusterFunctionsMulticore()].
 #' The batchtools multicore backend only works on operating systems
 #' supporting the `ps` command-line tool, e.g. Linux and macOS.

R/batchtools_openlava.R

@@ -7,7 +7,7 @@ BatchtoolsOpenLavaFutureBackend <- function(...) {
 }
 
 
-#' A batchtools openlava backend resolves futures in parallel via a OpenLava job scheduler
+#' A batchtools OpenLava backend resolves futures in parallel via a OpenLava job scheduler
 #'
 #' @inheritParams BatchtoolsTemplateFutureBackend
 #'
@@ -30,7 +30,7 @@ BatchtoolsOpenLavaFutureBackend <- function(...) {
 #' system.file("templates", "openlava.tmpl", package = "future.batchtools")
 #' ```
 #'
-#' and comprise:
+#' and comprises:
 #'
 #' `r paste(c("\x60\x60\x60bash", readLines("inst/templates/openlava.tmpl"), "\x60\x60\x60"), collapse = "\n")`
 #'

R/batchtools_sge.R

@@ -38,7 +38,7 @@ print.BatchtoolsSGEFutureBackend <- function(x, ...) {
 #' system.file("templates", "sge.tmpl", package = "future.batchtools")
 #' ```
 #'
-#' and comprise:
+#' and comprises:
 #'
 #' `r paste(c("\x60\x60\x60bash", readLines("inst/templates/sge.tmpl"), "\x60\x60\x60"), collapse = "\n")`
 #'

R/batchtools_slurm.R

@@ -16,7 +16,7 @@ print.BatchtoolsSlurmFutureBackend <- function(x, ...) {
 }
 
 
-#' A batchtools slurm backend resolves futures in parallel via a Slurm job scheduler
+#' A batchtools Slurm backend resolves futures in parallel via a Slurm job scheduler
 #'
 #' @inheritParams BatchtoolsTemplateFutureBackend
 #'
@@ -27,7 +27,7 @@ print.BatchtoolsSlurmFutureBackend <- function(x, ...) {
 #' @param \ldots Not used.
 #'
 #' @details
-#' Batchtools slurm futures use \pkg{batchtools} cluster functions
+#' Batchtools Slurm futures use \pkg{batchtools} cluster functions
 #' created by [makeClusterFunctionsSlurm2()], which are used
 #' to interact with the Slurm job scheduler. This requires that Slurm
 #' commands `sbatch`, `squeue`, `sacct`, and `scancel` are available on
@@ -39,7 +39,7 @@ print.BatchtoolsSlurmFutureBackend <- function(x, ...) {
 #' system.file("templates", "slurm.tmpl", package = "future.batchtools")
 #' ```
 #'
-#' and comprise:
+#' and comprises:
 #'
 #' `r paste(c("\x60\x60\x60bash", readLines("inst/templates/slurm.tmpl"), "\x60\x60\x60"), collapse = "\n")`
 #'

R/batchtools_ssh.R

@@ -1,4 +1,4 @@
-#' batchtools SSH futures
+#' Batchtools SSH futures
 #'
 #' A batchtools SSH future is an asynchronous multiprocess
 #' future that will be evaluated in a background R session.\cr
@@ -13,7 +13,7 @@
 #' @return An object of class `BatchtoolsMulticoreFuture`.
 #'
 #' @details
-#' batchtools SSH futures rely on the batchtools backend set
+#' Batchtools SSH futures rely on the batchtools backend set
 #' up by [batchtools::makeClusterFunctionsSSH()].
 #' The batchtools SSH backend only works on operating systems
 #' supporting the `ssh` and `ps` command-line tool, e.g. Linux and macOS.