getExportedNames {DockerParallel} | R Documentation |
Get the exported method and variable from the provider or container
Description
Get the exported method and variable from the provider or container. These
methods should be used by the developer to export their APIs to the user. The
DockerCluster
object will call getExportedNames
and getExportedObject
and
export them to the user.
Usage
getExportedNames(x)
getExportedObject(x, name)
## S4 method for signature 'ANY'
getExportedNames(x)
## S4 method for signature 'ANY'
getExportedObject(x, name)
Arguments
x |
A cloud provider or container object |
name |
The name of the exported object |
Details
If the exported object is a function, the exported function will be defined in
an environment such that the DockerCluster
object is assigned to the variable cluster
.
In other words, the exported function can use the variable cluster
without define it.
This can be useful if the developer needs to change anything in the cluster without
asking the user to provide the DockerCluster
object. The best practice is to define
cluster
as the function argument, the argument will be removed when the function is
exported to the user. The user would not be bothered with the redundant cluster
argument.
Value
getExportedNames: The names of the exported functions or variables getExportedObject: The exported functions or variable