1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/parallelRegisterLevels.R
\name{parallelGetRegisteredLevels}
\alias{parallelGetRegisteredLevels}
\title{Get registered parallelization levels for all currently loaded packages.}
\usage{
parallelGetRegisteredLevels(flatten = FALSE)
}
\arguments{
\item{flatten}{(\code{logical(1)})\cr
Flatten to character vector or not? See description.
Default is \code{FALSE}.}
}
\value{
\code{RegisteredLevels} | \code{character}. See above.
}
\description{
With \code{flatten = FALSE}, a structured S3 object is returned. The S3 object
only has one slot, which is called \code{levels}. This contains a named list. Each
name refers to \code{package} from the call to \code{\link[=parallelRegisterLevels]{parallelRegisterLevels()}}, while
the entries are character vectors of the form \dQuote{package.level}. With
\code{flatten = TRUE}, a simple character vector is returned that contains all
concatenated entries of \code{levels} from above.
}
|
