Package 'RedisBaseContainer'

Configure the server container environment,

Description

Configure the server container environment, the environment variable serverPort, serverPassword and sshPubKey will be set in this method

Usage

## S4 method for signature 'RedisContainer'
configServerContainerEnv(container, cluster, verbose = FALSE)

Arguments

container	Reference Container Object. The server container.
cluster	S4 DockerCluster object.
verbose	Integer. The verbose level, default 1.

Value

A RedisContainer object

---

Configure the worker container

Description

Configure the worker container

Usage

## S4 method for signature 'RedisContainer'
configWorkerContainerEnv(container, cluster, workerNumber, verbose = FALSE)

Arguments

container	Reference Container Object. The worker container.
cluster	S4 DockerCluster object.
workerNumber	Integer. The number of workers in a container.
verbose	Integer. The verbose level, default 1.

Value

A RedisContainer object

---

Get the exported object

Description

Get the exported object. The objects are 'getSysPackages', 'setSysPackages', 'addSysPackages', 'getRPackages', 'setRPackages' and 'addRPackages'. see details

Usage

## S4 method for signature 'RedisContainer'
getExportedNames(x)

## S4 method for signature 'RedisContainer'
getExportedObject(x, name)

Arguments

x	A cloud provider or container object
name	The name of the exported object

Details

The function XSysPackages can be used to install the system package for the worker container before running the R worker. The package will be installed by ⁠apt-get install⁠.

The function XRPackages will install the R packages for the container. The package is installed via AnVIL::install. It will first try the fast binary installation, then fallback to BiocManager::install. Therefore, you can also provide the GitHub package to this function.

Note that these function must be called before deploying the container. Setting the packages will have no effect on the running container.

Value

For the exported function: The current package vector

---

Get the Redis server container

Description

Get the Redis server container from the worker container

Usage

## S4 method for signature 'RedisContainer'
getServerContainer(workerContainer)

Arguments

workerContainer

The worker container.

Value

A RedisContainer server container

---

The base redis container

Description

The base redis container. It should not be directly used by the user.

---

Common RedisContainer parameter

Description

Common RedisContainer parameter

Arguments

image	Character, the container image
name	Character, the optional name of the container
environment	List, the environment variables in the container
tag	Character, the image tag

Value

No reuturn value

---

Get the Bioconductor Redis server container

Description

Get the Bioconductor Redis server container.

Usage

RedisServerContainer(environment = list(), tag = "latest")

Arguments

environment	List, the environment variables in the container
tag	Character, the image tag

Value

a RedisContainer object

Examples

RedisServerContainer()

---

Show the Redis container

Description

Show the Redis container

Usage

## S4 method for signature 'RedisContainer'
show(object)

Arguments

object

The RedisContainer object

Value

No return value

---