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
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/BatchtoolsCustomFuture-class.R,
% R/BatchtoolsFuture-class.R, R/BatchtoolsMultiprocessFuture-class.R,
% R/BatchtoolsSSHFuture-class.R, R/BatchtoolsUniprocessFuture-class.R
\name{BatchtoolsCustomFuture}
\alias{BatchtoolsCustomFuture}
\alias{BatchtoolsBashFuture}
\alias{BatchtoolsFuture}
\alias{BatchtoolsMultiprocessFuture}
\alias{BatchtoolsMulticoreFuture}
\alias{BatchtoolsTemplateFuture}
\alias{BatchtoolsLsfFuture}
\alias{BatchtoolsOpenLavaFuture}
\alias{BatchtoolsSGEFuture}
\alias{BatchtoolsSlurmFuture}
\alias{BatchtoolsTorqueFuture}
\alias{BatchtoolsSSHFuture}
\alias{BatchtoolsUniprocessFuture}
\alias{BatchtoolsLocalFuture}
\alias{BatchtoolsInteractiveFuture}
\title{A batchtools future is a future whose value will be resolved via batchtools}
\usage{
BatchtoolsCustomFuture(
expr = NULL,
substitute = TRUE,
envir = parent.frame(),
...
)
BatchtoolsBashFuture(
expr = NULL,
substitute = TRUE,
envir = parent.frame(),
...
)
BatchtoolsFuture(
expr = NULL,
envir = parent.frame(),
substitute = TRUE,
globals = TRUE,
packages = NULL,
label = NULL,
resources = list(),
workers = NULL,
finalize = getOption("future.finalize", TRUE),
conf.file = findConfFile(),
cluster.functions = NULL,
registry = list(),
...
)
BatchtoolsMultiprocessFuture(
expr = NULL,
substitute = TRUE,
envir = parent.frame(),
...
)
BatchtoolsMulticoreFuture(
expr = NULL,
substitute = TRUE,
envir = parent.frame(),
...
)
BatchtoolsTemplateFuture(
expr = NULL,
substitute = TRUE,
envir = parent.frame(),
...
)
BatchtoolsLsfFuture(
expr = NULL,
substitute = TRUE,
envir = parent.frame(),
...
)
BatchtoolsOpenLavaFuture(
expr = NULL,
substitute = TRUE,
envir = parent.frame(),
...
)
BatchtoolsSGEFuture(
expr = NULL,
substitute = TRUE,
envir = parent.frame(),
...
)
BatchtoolsSlurmFuture(
expr = NULL,
substitute = TRUE,
envir = parent.frame(),
...
)
BatchtoolsTorqueFuture(
expr = NULL,
substitute = TRUE,
envir = parent.frame(),
...
)
BatchtoolsSSHFuture(
expr = NULL,
substitute = TRUE,
envir = parent.frame(),
workers = availableCores(),
...
)
BatchtoolsUniprocessFuture(
expr = NULL,
substitute = TRUE,
envir = parent.frame(),
...
)
BatchtoolsLocalFuture(
expr = NULL,
substitute = TRUE,
envir = parent.frame(),
...
)
BatchtoolsInteractiveFuture(
expr = NULL,
substitute = TRUE,
envir = parent.frame(),
...
)
}
\arguments{
\item{expr}{The R expression to be evaluated}
\item{substitute}{Controls whether \code{expr} should be
\code{substitute()}:d or not.}
\item{envir}{The environment in which global environment
should be located.}
\item{globals}{(optional) a logical, a character vector, a named list, or a
\link[globals:Globals]{Globals} object. If TRUE, globals are identified by code
inspection based on \code{expr} and \code{tweak} searching from environment
\code{envir}. If FALSE, no globals are used. If a character vector, then
globals are identified by lookup based their names \code{globals} searching
from environment \code{envir}. If a named list or a Globals object, the
globals are used as is.}
\item{label}{(optional) Label of the future (where applicable, becomes the
job name for most job schedulers).}
\item{resources}{(optional) A named list passed to the \pkg{batchtools}
template (available as variable \code{resources}). See Section 'Resources'
in \code{\link[batchtools:submitJobs]{batchtools::submitJobs()}} more details.}
\item{workers}{(optional) The maximum number of workers the batchtools
backend may use at any time. Interactive and "local" backends can only
process one future at the time (\code{workers = 1L}), whereas HPC backends,
where futures are resolved via separate jobs on a scheduler, can have
multiple workers. In the latter, the default is \code{workers = NULL}, which
will resolve to
\code{getOption("\link{future.batchtools.workers}")}.
If neither are specified, then the default is \code{100}.}
\item{finalize}{If TRUE, any underlying registries are
deleted when this object is garbage collected, otherwise not.}
\item{conf.file}{(optional) A batchtools configuration file.}
\item{cluster.functions}{(optional) A batchtools
\link[batchtools:makeClusterFunctions]{ClusterFunctions} object.}
\item{registry}{(optional) A named list of settings to control the setup
of the batchtools registry.}
\item{\ldots}{Additional arguments passed to \code{\link[future:Future-class]{future::Future()}}.}
}
\value{
A BatchtoolsFuture object
}
\description{
A batchtools future is a future whose value will be resolved via batchtools
}
\keyword{internal}
|
