batchtools: cfBrewTemplate – R documentation

Pricing

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

Get Started for Free

Documentation

batchtools

cfBrewTemplate

Cluster Functions Helper to Write Job Description Files

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 “jobs”-subdir of your files directory.

Usage

cfBrewTemplate(reg, text, jc)

Arguments

`reg`	[`Registry`] Registry. If not explicitly passed, uses the default registry (see `setDefaultRegistry`).
`text`	[`character(1)`] String ready to be brewed. See `cfReadBrewTemplate` to read a template from the file system.
`jc`	[`JobCollection)`] Will be used as environment to brew the template file in. See `JobCollection` for a list of all available variables.

Value

[character(1)]. File path to brewed template file.