File: parallelGetOptions.Rd

package info (click to toggle)
r-cran-parallelmap 1.5.1-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 336 kB
  • sloc: sh: 13; makefile: 2
file content (21 lines) | stat: -rw-r--r-- 689 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/parallelShowOptions.R
\name{parallelGetOptions}
\alias{parallelGetOptions}
\title{Retrieve the configured package options.}
\usage{
parallelGetOptions()
}
\value{
\code{ParallelMapOptions}. See above.
}
\description{
Returned are current and default settings, both as lists.
The return value has slots elements \code{settings} and \code{defaults},
which are both lists of the same structure, named by option names.

A printer exists to display this object.

For details on the configuration procedure please read
\code{\link[=parallelStart]{parallelStart()}} and \url{https://github.com/mlr-org/parallelMap}.
}