define_cluster {derfinder} | R Documentation

## Define a cluster to use.

### Description

Define a cluster to use.

### Usage

    define_cluster(cores = "mc.cores", ...)

### Arguments

`cores` | The argument to use to define the number of cores. This is useful for cases with nested parallelizations.
`...` | Advanced arguments are: mc.cores If 1 (default), then SerialParam will be used. If greater than 1, then it specifies the number of workers for SnowParam. mc.log Passed to `log` when using SnowParam. BPPARAM.custom If specified, that's the BPPARAM that will be used.

### Details

This function is used internally in many functions.

### Value

A BiocParallel *Param object

### Author(s)

Leonardo Collado-Torres

### Examples

    ## Use SerialParam()
    define_cluster(mc.cores = 1)

    ## Note that BPPARAM.custom takes precedence
    define_cluster(mc.cores = 2, BPPARAM.custom = BiocParallel::SerialParam())

[Package derfinder version 1.24.2 Index]