File: getDoSeqWorkers.Rd

package info (click to toggle)
r-cran-foreach 1.4.2-1
  • links: PTS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 772 kB
  • ctags: 3
  • sloc: sh: 58; makefile: 1
file content (40 lines) | stat: -rw-r--r-- 1,189 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
\name{getDoSeqWorkers}
\alias{getDoSeqWorkers}
\alias{getDoSeqRegistered}
\alias{getDoSeqName}
\alias{getDoSeqVersion}
\title{Functions Providing Information on the doSeq Backend}
\description{
The \code{getDoSeqWorkers} function returns the number of
execution workers there are in the currently registered doSeq backend.
A \code{1} is returned by default.

The \code{getDoSeqRegistered} function returns TRUE if a doSeq backend
has been registered, otherwise FALSE.

The \code{getDoSeqName} function returns the name of the currently
registered doSeq backend.  A \code{NULL} is returned if no backend is
registered.

The \code{getDoSeqVersion} function returns the version of the currently
registered doSeq backend.  A \code{NULL} is returned if no backend is 
registered.
}
\usage{
getDoSeqWorkers()
getDoSeqRegistered()
getDoSeqName()
getDoSeqVersion()
}

\examples{
cat(sprintf('\%s backend is registered\n',
            if(getDoSeqRegistered()) 'A' else 'No'))
cat(sprintf('Running with \%d worker(s)\n', getDoSeqWorkers()))
(name <- getDoSeqName())
(ver <- getDoSeqVersion())
if (getDoSeqRegistered())
  cat(sprintf('Currently using \%s [\%s]\n', name, ver))
}

\keyword{utilities}