batchScan: Perform a batch of QTL analysis.

Description Usage Arguments Value See Also

View source: R/batchScan.R

Description

The specified scanfunction is applied to the cross for every element in vector x. This function uses the parallel package to set up a cluster, initialiase a random-number generator stream, and run the batch in parallel.

Usage

1
batchScan(x, scanfunction, cross, n.cluster = 1, iseed = NULL, ...)

Arguments

x

An atomic vector to which the scan function is applied elementwise.

scanfunction

QTL scan function. The first argument of this function must be the element of x that is passed by clusterApply, and its second argument should be the cross object.

cross

An R/qtl cross object.

n.cluster

Number of nodes to request for parallel execution. Any number of processes can be requested with the argument n.cluster, but the number actually returned can be limited to the number of processes available. On a local computer, this limit is the number of physical cores in the computer. In a PBS batch system, the maximum number of processes will be set from the PBS node file.

iseed

Seed for random number generator stream.

...

Additional keyword arguments passed to the scan function.

Value

List of QTL scan results.

See Also

Other scan utility functions: batchPermScanoneF, batchPermScanone, batchPermScantwoF, batchPermScantwo, batchPhenoScanone, batchPhenoScantwo, nodePermScanoneF, nodePermScanone, nodePermScantwoF, nodePermScantwo, nodePhenoScanone, nodePhenoScantwo


gact/shmootl documentation built on Nov. 11, 2021, 6:23 p.m.