File: cfBrewTemplate.Rd

package info (click to toggle)
r-cran-batchtools 0.9.15%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 1,416 kB
  • sloc: ansic: 172; sh: 156; makefile: 2
file content (39 lines) | stat: -rw-r--r-- 1,373 bytes parent folder | download | duplicates (3)
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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/clusterFunctions.R
\name{cfBrewTemplate}
\alias{cfBrewTemplate}
\title{Cluster Functions Helper to Write Job Description Files}
\usage{
cfBrewTemplate(reg, text, jc)
}
\arguments{
\item{reg}{[\code{\link{Registry}}]\cr
Registry. If not explicitly passed, uses the default registry (see \code{\link{setDefaultRegistry}}).}

\item{text}{[\code{character(1)}]\cr
String ready to be brewed. See \code{\link{cfReadBrewTemplate}} to read a template from the file system.}

\item{jc}{[\code{\link{JobCollection})}]\cr
Will be used as environment to brew the template file in. See \code{\link{JobCollection}} for a list of all
available variables.}
}
\value{
[\code{character(1)}]. File path to brewed template file.
}
\description{
This function is only intended for use in your own cluster functions implementation.

Calls brew silently on your template, any error will lead to an exception.
The file is stored at the same place as the corresponding job file in the \dQuote{jobs}-subdir
of your files directory.
}
\seealso{
Other ClusterFunctionsHelper: 
\code{\link{cfHandleUnknownSubmitError}()},
\code{\link{cfKillJob}()},
\code{\link{cfReadBrewTemplate}()},
\code{\link{makeClusterFunctions}()},
\code{\link{makeSubmitJobResult}()},
\code{\link{runOSCommand}()}
}
\concept{ClusterFunctionsHelper}