mllg / batchtools

Tools for computation on batch systems
https://mllg.github.io/batchtools/
GNU Lesser General Public License v3.0
170 stars 51 forks source link

Documentation for 'seed' default in 'makeRegistry' wrong #223

Closed mb706 closed 5 years ago

mb706 commented 5 years ago

seed is initialized in makeRegistry the following way:

 seed = if (is.null(seed)) as.integer(runif(1L, 0, 32768)) else asCount(seed, positive = TRUE)

However, the documentation for the seed parameter in makeRegistry states

Default is a random number in the range [1, \code{.Machine$integer.max/2}].

The lower bound is wrong, the upper bound is technically true but misleading.