FindEmoticonPipe {bdpar}

Class to find and/or remove the emoticons on the data field of an Instance

Description

This class is responsible of detecting the existing emoticons in the data field of each Instance. Identified emoticons are stored inside the emoticon field of Instance class. Moreover if required, is able to perform inline emoticon removement.

Details

The regular expression indicated in the emoticonPattern variable is used to identify emoticons.

Note

FindEmoticonPipe will automatically invalidate the Instance whenever the obtained data is empty.

Inherit

This class inherits from GenericPipe and implements the pipe abstract function.

Super class

bdpar::GenericPipe -> FindEmoticonPipe

Public fields

emoticonPattern

A character value. The regular expression to detect emoticons.

Methods

Public methods

• FindEmoticonPipe$new()

• FindEmoticonPipe$pipe()

• FindEmoticonPipe$findEmoticon()

• FindEmoticonPipe$removeEmoticon()

• FindEmoticonPipe$clone()

Inherited methods

• bdpar::GenericPipe$getAlwaysBeforeDeps()
• bdpar::GenericPipe$getNotAfterDeps()
• bdpar::GenericPipe$getPropertyName()
• bdpar::GenericPipe$hash()
• bdpar::GenericPipe$setAlwaysBeforeDeps()
• bdpar::GenericPipe$setNotAfterDeps()
• bdpar::GenericPipe$setPropertyName()

Method new()

Creates a FindEmoticonPipe object.

Usage

FindEmoticonPipe$new(
  propertyName = "emoticon",
  alwaysBeforeDeps = list(),
  notAfterDeps = list("FindHashtagPipe"),
  removeEmoticons = TRUE
)

Arguments

propertyName

A character value. Name of the property associated with the GenericPipe.

alwaysBeforeDeps

A list value. The dependencies alwaysBefore (GenericPipes that must be executed before this one).

notAfterDeps

A list value. The dependencies notAfter (GenericPipes that cannot be executed after this one).

removeEmoticons

A logical value. Indicates if the emoticons are removed.

propertyLanguageName

A character value. Name of the language property.

Method pipe()

Preprocesses the Instance to obtain/remove the emoticons. The emoticons found in the data are added to the list of properties of the Instance.

Usage

FindEmoticonPipe$pipe(instance)

Arguments

instance

A Instance value. The Instance to preprocess.

Returns

The Instance with the modifications that have occurred in the pipe.

Method findEmoticon()

Finds the emoticons in the data.

Usage

FindEmoticonPipe$findEmoticon(data)

Arguments

data

A character value. The text to search the emoticons.

Returns

The list with emoticons found.

Method removeEmoticon()

Removes the emoticons in the data.

Usage

FindEmoticonPipe$removeEmoticon(data)

Arguments

data

A character value. The text where emoticons will be removed.

Returns

The data with the emoticons removed.

Method clone()

The objects of this class are cloneable with this method.

Usage

FindEmoticonPipe$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

See Also

AbbreviationPipe, ContractionPipe, File2Pipe, FindEmojiPipe, FindHashtagPipe, FindUrlPipe, FindUserNamePipe, GuessDatePipe, GuessLanguagePipe, Instance, InterjectionPipe, MeasureLengthPipe, GenericPipe, SlangPipe, StopWordPipe, StoreFileExtPipe, TargetAssigningPipe, TeeCSVPipe, ToLowerCasePipe