Platform: Platform

Description Usage Format Details Value Methods Active Bindings Author(s) Examples

Description

Platform Class the creates and manages environments.

Usage

1

Format

An object of class R6ClassGenerator of length 24.

Details

This class creates and manages environments. An environment is essentially a directory in which project data resides. Multiple environments can be created to provide multiple data environments. This is especially useful for projects with large data sets or computationally expense analyses.

Value

Object of R6Class with methods for managing environments

Methods

new(pName, pDesc)

Initializes the platform

createEnv(envName, envDesc, envPath, envStatus)

Creates an environment

archiveEnv(environment)

Archives an environment

listEnv()

Provides a data frame of environments in the platform

Active Bindings

currentEnv

Gets and sets the current environment

Author(s)

John James, j2sdatalab@gmail.com

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
## Not run: 
predictor$new(pName = "predictor", pDesc = "Platform for predictor project")
predictor$createEnv(envName = "test", envDesc = "Test Environment",
                    envPath = "test", envStatus = TRUE)
predictor$archiveEnv(name = 'test')
predictor$listEnv()
predictor$currentEnv
predictor$currentEnv <- "production"

## End(Not run)

j2scode/predictifyR documentation built on May 14, 2019, 10:34 a.m.