beta.para.control: Specifying Control Values for Internal Parallel Cluster

View source: R/functional.betapart.core.pairwise.R

beta.para.controlR Documentation

Specifying Control Values for Internal Parallel Cluster

Description

The values supplied in the beta.para.control() call replace the defaults, and a list with all settings (i.e., values for all possible arguments) is returned. The returned list is used to define the internal parallel cluster of the functional.betapart.core function.

Usage

beta.para.control(nc = floor(parallel::detectCores()/2), type = "SOCK", 
                              LB = TRUE, size = 1)

Arguments

nc

number of cores to use. Default is half of the available cores.

type

character - the type of cluster to be used, either "SOCK", "PSOCK" or "FORK" (not on Windows).

LB

logical indicating if load balancing has to be used. Default is TRUE

size

number of operation run on each core at each iteration. Default is 1.

Value

a list with components for each of the possible arguments.

Author(s)

Maxime Logez

Examples

str(beta.para.control(nc = 2, LB = FALSE))

betapart documentation built on March 31, 2023, 10:29 p.m.