distcompSetup: Setup a workspace and configuration for a distributed...

In hrpcisd/distcomp: Computations over Distributed Data without Aggregation

Setup a workspace and configuration for a distributed computation

Description

The function distcompSetup sets up a distributed computation and configures some global parameters such as definition file names, data file names, instance object file names, and ssl configuration parameters. The function creates some of necessary subdirectories if not already present and throws an error if the workspace areas are not writeable

Usage

distcompSetup(
  workspacePath = "",
  defnPath = paste(workspacePath, "defn", sep = .Platform$file.sep),
  instancePath = paste(workspacePath, "instances", sep = .Platform$file.sep),
  defnFileName = "defn.rds",
  dataFileName = "data.rds",
  instanceFileName = "instance.rds",
  resultsCacheFileName = "results_cache.rds",
  ssl_verifyhost = 1L,
  ssl_verifypeer = 1L
)

Arguments

workspacePath	a folder specifying the workspace path. This has to be writable by the opencpu process. On a cloud opencpu server on Ubuntu, for example, this requires a one-time modification of apparmor profiles to enable write permissions to this path
defnPath	the path where definition files will reside, organized by computation identifiers
instancePath	the path where instance objects will reside
defnFileName	the name for the compdef definition files
dataFileName	the name for the data files
instanceFileName	the name for the instance files
resultsCacheFileName	the name for the instance results cache files for HE computations
ssl_verifyhost	integer value, usually 1L, but for testing with snake-oil certs, one might set this to 0L
ssl_verifypeer	integer value, usually 1L, but for testing with snake-oil certs, one might set this to 0L

Value

TRUE if all is well

See Also

getConfig()

Examples

## Not run: 
distcompSetup(workspacePath="./workspace")

## End(Not run)

hrpcisd/distcomp documentation built on Feb. 14, 2023, 4:56 p.m.