Evaluate an expression in Civis Platform
CivisFuture(
expr = NULL,
envir = parent.frame(),
substitute = FALSE,
globals = TRUE,
packages = NULL,
lazy = FALSE,
local = TRUE,
gc = FALSE,
earlySignal = FALSE,
label = NULL,
required_resources = list(cpu = 1024, memory = 2048, diskSpace = 4),
docker_image_name = "civisanalytics/datascience-r",
docker_image_tag = "latest",
...
)# S3 method for CivisFuture
run(future, ...)
# S3 method for CivisFuture
result(future, ...)
# S3 method for CivisFuture
cancel(future, ...)
# S3 method for CivisFuture
resolved(future, ...)
# S3 method for CivisFuture
fetch_logs(object, ...)
A CivisFuture
inheriting from Future
that evaluates expr
on the given container.
An R expression.
The environment from where global objects should be identified.
If TRUE, argument expr
is
substitute()
:ed, otherwise not.
(optional) a logical, a character vector, or a named list
to control how globals are handled.
For details, see section 'Globals used by future expressions'
in the help for future()
.
(optional) a character vector specifying packages to be attached in the R environment evaluating the future.
If FALSE (default), the future is resolved eagerly (starting immediately), otherwise not.
If TRUE, the expression is evaluated such that all assignments are done to local temporary environment, otherwise the assignments are done to the global environment of the R process evaluating the future.
If TRUE, the garbage collector run (in the process that
evaluated the future) only after the value of the future is collected.
Exactly when the values are collected may depend on various factors such
as number of free workers and whether earlySignal
is TRUE (more
frequently) or FALSE (less frequently).
Some types of futures ignore this argument.
Specified whether conditions should be signaled as soon as possible or not.
An optional character string label attached to the future.
resources, see scripts_post_containers
the image for the container script.
the tag for the Docker image.
arguments to scripts_post_containers
CivisFuture object.
CivisFuture
run
: Run a CivisFuture
result
: Return the value of a CivisFuture
cancel
: Cancel a CivisFuture
resolved
: Check if a CivisFutre has resolved
fetch_logs
: Fetch logs from a CivisFuture