ContractionPipe {bdpar}R Documentation

Class to find and/or replace the contractions on the data field of a Instance

Description

ContractionPipe class is responsible for detecting the existing contractions in the data field of each Instance. Identified contractions are stored inside the contraction field of Instance class. Moreover if needed, is able to perform inline contractions replacement.

Details

ContractionPipe class requires the resource files (in json format) containing the correspondence between contractions and meaning. To this end, the language of the text indicated in the propertyLanguageName should be contained in the resource file name (ie. contr.xxx.json where xxx is the value defined in the propertyLanguageName ). The location of the resources should be defined in the "resources.contractions.path" field of bdpar.Options variable.

Note

ContractionPipe 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 -> ContractionPipe

Methods

Public methods

Inherited methods

Method new()

Creates a ContractionPipe object.

Usage
ContractionPipe$new(
  propertyName = "contractions",
  propertyLanguageName = "language",
  alwaysBeforeDeps = list("GuessLanguagePipe"),
  notAfterDeps = list(),
  replaceContractions = TRUE,
  resourcesContractionsPath = NULL
)
Arguments
propertyName

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

propertyLanguageName

A character value. Name of the language property.

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).

replaceContractions

A logical value. Indicates if the contractions are replaced or not.

resourcesContractionsPath

A character value. Path of resource files (in json format) containing the correspondence between contractions and meaning.


Method pipe()

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

Usage
ContractionPipe$pipe(instance)
Arguments
instance

A Instance value. The Instance to preprocess.

Returns

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


Method findContraction()

Checks if the contraction is in the data.

Usage
ContractionPipe$findContraction(data, contraction)
Arguments
data

A character value. The text where contraction will be searched.

contraction

A character value. Indicates the contraction to find.

Returns

A logical value depending on whether the contraction is in the data.


Method replaceContraction()

Replaces the contraction in the data for the extendedContraction.

Usage
ContractionPipe$replaceContraction(contraction, extendedContraction, data)
Arguments
contraction

A character value. Indicates the contraction to replace.

extendedContraction

A character value. Indicates the string to replace for the contractions found.

data

A character value. The text where contraction will be replaced.

Returns

The data with the contractions replaced.


Method getPropertyLanguageName()

Gets the name of property language.

Usage
ContractionPipe$getPropertyLanguageName()
Returns

Value of name of property language.


Method getResourcesContractionsPath()

Gets the path of contractions resources.

Usage
ContractionPipe$getResourcesContractionsPath()
Returns

Value of path of contractions resources.


Method setResourcesContractionsPath()

Sets the path of contractions resources.

Usage
ContractionPipe$setResourcesContractionsPath(path)
Arguments
path

A character value. The new value of the path of contractions resources.


Method clone()

The objects of this class are cloneable with this method.

Usage
ContractionPipe$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

See Also

AbbreviationPipe, bdpar.Options, File2Pipe, FindEmojiPipe, FindEmoticonPipe, FindHashtagPipe, FindUrlPipe, FindUserNamePipe, GuessDatePipe, GuessLanguagePipe, Instance, InterjectionPipe, MeasureLengthPipe, GenericPipe, ResourceHandler, SlangPipe, StopWordPipe, StoreFileExtPipe, TargetAssigningPipe, TeeCSVPipe, ToLowerCasePipe


[Package bdpar version 3.0.0 Index]