parallelMap (version 1.2)

parallelRegisterLevels: Register a parallelization level

Description

Package developers should call this function in their packages' .onLoad. This enables the user to query available levels and bind parallelization to specific levels. This is especially helpful in case of nested calls to parallelMap, i.e. where the inner call should be parallelized instead of the outer one.

To avoid name clases, we encourage developes to always sepecify the argument package. This will prefix the specified levels with the string containing the package name, e.g. parallelRegisterLevels(package="foo", levels="dummy") will register the level foo.dummy and users can start parallelization for this level with parallelStart(, level = "parallelMap.dummy"). If you do not provide package, the level names will be associated with category custom and can there be later refered to with custom.dummy.

Usage

parallelRegisterLevels(package = "custom", levels)

Arguments

package

[character(1)] Name of your package. Default is custom (we are not in a package).

levels

[character(1)] Availabe levels that are used in the parallelMap operations of your package or code. If package is not missing, all levels will be prefixed with [package

Value

• Nothing.