bdpar (version 2.0.0)

runPipeline: Initiates the pipelining process

Description

runPipeline is responsible for easily initialize the pipelining preprocessing proccess.

Usage

runPipeline(path, extractors = ExtractorFactory$new(),
pipeline = DefaultPipeline$new())

Arguments

path

(character) path where the files to be preprocessed are located.

extractors

(ExtractorFactory) object implementing the method createInstance to choose which type of Instance is created.

pipeline

(GenericPipeline) subclass of GenericPipeline, which implements the whole pipeling process.

Value

List of Instance that have been preprocessed.

Details

In the case that some pipe, defined on the workflow, needs some type of configuration, it can be defined throught bdpar.Options variable which have differents methods to support the funcionality of different pipes.

See Also

Bdpar, bdpar.Options, Connections,DefaultPipeline, DynamicPipeline, GenericPipeline, Instance, ExtractorFactory, ResourceHandler

Examples

# NOT RUN {
#If it is necessary to indicate any existing configuration key, do it through:
#bdpar.Options$set(key, value)
#If the key is not initialized, do it through:
#bdpar.Options$add(key, value)

#Folder with the files to preprocess
path <- system.file(file.path("example"),
                    package = "bdpar")

#Object which decides how creates the instances
extractors <- ExtractorFactory$new()

#Object which indicates the pipes' flow
pipeline <- DefaultPipeline$new()

#Starting file preprocessing...
runPipeline(path = path,
            extractors = extractors,
            pipeline = pipeline)
# }