Lab: Lab

Description Usage Arguments Format Details Author(s)

Description

Lab Class that contains document collections and the environment in which NLP happens.

Usage

1

Arguments

name

A character string containing the name of the Lab object. This variable is used in the instantiation and remove methods.

desc

A chararacter string containing the description of the Lab

document

An object of the DocumentCollection class to be added to the Lab object's list of document collections.

visitor

An object of one of the visitor classes.

Format

An object of class R6ClassGenerator of length 24.

Details

The environment in which NLP happens. There are two groups of methods. The first group allows clients to instantiate, retrieve, print, enter, leave, and archive a Lab object. The second set of methods allow clients to retrieve the contained documents, add a document, and remove a document.

Lab Core Methods:

new(name, desc = NULL)

Creates an object of Lab Class

desc

A getter/setter method allowing clients to retrieve and set the Lab description variable.

getName()

Returns the name of the Lab object.

Lab Aggregate Methods:

getChildren()

Retrieves a list containing meta data for child objects of the DocumentCollection class.

addChild(document)

Adds a child document, an object of the DocumentCollection class, to the Lab object.

removeChild(document)

Removes a child document, an object of the DocumentCollection class, from the Lab object.

parent(value)

Getter/setter method for the parent field, implemented as an active binding on the private member.

Lab Visitor Methods:

accept(visitor)

Accepts an object of the Visitor family of classes.

Author(s)

John James, [email protected]


DataScienceSalon/NLPStudio1 documentation built on March 19, 2018, 4:10 a.m.