TargetAssigningPipe {bdpar}R Documentation

Class to get the target field of the Instance

Description

This class allows searching in the path the target of the Instance.

Details

The targets that are searched can be controlled through the constructor of the class where targetsName will be the string that is searched within the path and targets has the values that the property can take.

Inherit

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

Super class

bdpar::GenericPipe -> TargetAssigningPipe

Methods

Public methods

Inherited methods

Method new()

Creates a TargetAssigningPipe object.

Usage
TargetAssigningPipe$new(
  targets = list("ham", "spam"),
  targetsName = list("_ham_", "_spam_"),
  propertyName = "target",
  alwaysBeforeDeps = list(),
  notAfterDeps = list()
)
Arguments
targets

A list value. Name of the targets property.

targetsName

A list value. The name of folders.

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


Method pipe()

Preprocesses the Instance to obtain the target.

Usage
TargetAssigningPipe$pipe(instance)
Arguments
instance

A Instance value. The Instance to preprocess.

Returns

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


Method getTarget()

Gets the target from a path.

Usage
TargetAssigningPipe$getTarget(path)
Arguments
path

A character value. The path to analyze.

Returns

The target of the path.


Method checkTarget()

Checks if the target is in the path.

Usage
TargetAssigningPipe$checkTarget(target, path)
Arguments
target

A character value. The target to find in the path.

path

A character value. The path to analize.

Returns

if the target is found, returns target, else returns "".


Method getTargets()

Gets of targets.

Usage
TargetAssigningPipe$getTargets()
Returns

Value of targets.


Method clone()

The objects of this class are cloneable with this method.

Usage
TargetAssigningPipe$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.

See Also

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


[Package bdpar version 3.0.0 Index]