File: FutureGlobals.Rd

package info (click to toggle)
r-cran-future 1.11.1.1%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 1,380 kB
  • sloc: sh: 14; makefile: 2
file content (37 lines) | stat: -rw-r--r-- 980 bytes parent folder | download
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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/FutureGlobals-class.R
\name{FutureGlobals}
\alias{FutureGlobals}
\alias{as.FutureGlobals}
\alias{as.FutureGlobals.FutureGlobals}
\alias{as.FutureGlobals.Globals}
\alias{as.FutureGlobals.list}
\alias{[.FutureGlobals}
\alias{c.FutureGlobals}
\alias{unique.FutureGlobals}
\title{A representation of a set of globals used with futures}
\usage{
FutureGlobals(object = list(), resolved = FALSE,
  total_size = NA_real_, ...)
}
\arguments{
\item{object}{A named list.}

\item{resolved}{A logical indicating whether these globals
have been scanned for and resolved futures or not.}

\item{total_size}{The total size of all globals, if known.}

\item{\dots}{Not used.}
}
\value{
An object of class \code{FutureGlobals}.
}
\description{
A representation of a set of globals used with futures
}
\details{
This class extends the \link[globals]{Globals} class by add
attribute \code{resolved}.
}
\keyword{internal}