NLPStudio: NLPStudio
In j2scode/NLPStudio: Natural Language Processing Environment

Description Usage Arguments Format Details Author(s) Examples

NLPStudio Class the creates and manages labs.

NLPStudio

`lab`	An object of class 'Lab'.
`stateId`	Character string indicating the stateId which uniquely identifies a serialized object at prior state.

An object of class R6ClassGenerator of length 24.

This class creates and manages data labs A data lab is essentially a directory in which project data reside. Multiple data labs can be created to house separate versions of the data for analysis. Note: This class is a singleton pattern. An NLPStudio object called nlpStudio is instantiated at load time. Any subsequent initializations will return the single nlpStudio instance. There are two sets of methods. The first set enables clients to retrieve information about the NLPStudio object. The second set allows clients to add, remove, enter, and leave labs.

NLPStudio Core Methods:

new(): Initializes the NLPStudio. This is a singleton class in which its only object is created when the package is loaded. The object instantiated at package load time is called "nlpStudio".
getInstance(): Returns the current NLPStudio instance object. This will be the only instantiation called "nlpStudio.

getName(): Returns the name of the current NLPStudio object.
exposeObject(requester): Returns the current object elements in list format if invoked by ah authorized requester.
restore(requester, prior): Restores the object to a prior state of invoked by an authorized requester.

NLPSTudio Lab Methods:

getChildren(): Returns the list of member labs in the nlpStudio object.
addChild(lab, enter = TRUE): Adds an existing lab to the NLPStudio object list of labs. If enter is set to TRUE, the currentLab and currentLabName variables are updated accordingly.
removeChild(lab, purge = FALSE): Method which archives and removes the lab from the nlpStudio objectd. If purge is set to TRUE, the lab is removed from memory, disk, and state.
parent(value): Getter/setter method for the parent field, implemented as an active binding on the private member.

NLPSTudio State Methods:

saveState(): Method for saving the current state of an NLPObject and its descendants.
restoreState(): Method for restoring an NLPStudio object to a prior state as designated by a state id.

NLPSTudio Visitor Methods:

accept(visitor)Method for accepting the visitor objects. Subclasses override these methods.

John James, jjames@datasciencesalon.org

## Not run: 
nlpStudio$exposeObject() # Returns nlpStudio object and meta data in list format
Lab$new(name = "List", desc = "Lisa Simpon's lab")
Lab$new(name = "Bart", desc = "Bart Simpon's lab")
nlpStudio$addChild(Lisa, enter = FALSE) # Adds lab without setting it current.
nlpStudio$addChild(Bart, enter = TRUE) # Adds lab and sets it current.
nlpStudio$removeChild("Bart") # Success!
nlpStudio$getChildren()

## End(Not run)