Description Usage Arguments Format Details Inherit Methods Private fields See Also
This class allows you to preprocess the data of an instance to find the contractions that are in it. Optionally, you can decide whether to replace the data contractions or not.
1 2 3 4 | ContractionsPipe$new(propertyName = "contractions",
propertyLanguageName = "language",
alwaysBeforeDeps = list("GuessLanguagePipe"),
notAfterDeps = list())
|
propertyName |
(character) Name of the property associated with the pipe. |
propertyLanguageName |
(character) Name of the language property. |
alwaysBeforeDeps |
(list) The dependences alwaysBefore (pipes that must be executed before this one). |
notAfterDeps |
(list) The dependences notAfter (pipes that cannot be executed after this one). |
An object of class R6ClassGenerator
of length 24.
This class needs files in json format that will contain the contractions to be located and the string that will replace them. For this it is necessary that the instance contains a property that indicates the language of the data to be able to correctly choose the list of contractions that apply to the data. The format of the file names of the resources has to be: contr.xxx.json (Being xxx the value of the language property of the instance).
To indicate the path where the associated resources are located, the configuration file is used. It is necessary to indicate in the section called resourcesPath, the path of resourcesContractionsPath.
The pipe will invalidate the instance in the moment that the resulting data is empty.
This class inherits from PipeGeneric
and implements the
pipe
abstract function.
pipe Function that preprocesses the instance to obtain/replace the contractions. The contractions found in the pipe are added to the list of properties of the Instance. If the replaceContractions parameter is TRUE, the instance data will be modified by replacing the contractions found.
Usage
pipe(instance, replaceContractions = TRUE)
Value
The instance with the modifications that have occurred in the pipe.
Arguments
instance (Instance) Instance to preproccess.
replaceContractions (logical) Indicates if the contractions are replace or not.
findContraction Function that checks if the contractions is in the data.
Usage
findContraction(data, contraction)
Value
TRUE or FALSE depending on whether the contraction is on the data.
Arguments
data (character) Text in which the contraction is searched.
contraction (character) Indicates the contraction to find.
replaceContraction Function that replaces the contraction in the data for the extendedContraction.
Usage
replaceContraction(contraction, extendedContraction, data)
Value
The data with the contractions replaced.
Arguments
contraction (character) Indicates the contraction to remove.
extendedContraction (character) Indicates the string to replace for the contraction found.
data (character) Text in which contractions will be replaced.
getPropertyLanguageName Getter of name of property language.
Usage
getPropertyLanguageName()
Value
Value of name of property language.
getResourcesContractionsPath Getter of path of contractions resources.
Usage
getResourcesContractionsPath()
Value
Value of path of contractions resources.
propertyLanguageName (character) The name of property about language.
resourcesContractionsPath (character) The path where are the resources.
PipeGeneric
, Instance
,
ResourceHandler
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.