runPipeline {bdpar}R Documentation

Initiates the pipelining process

Description

runPipeline is responsible for easily initialize the pipelining preprocessing process.

Usage

runPipeline(path, extractors = ExtractorFactory$new(),
pipeline = DefaultPipeline$new(), cache = TRUE, verbose = FALSE, summary = FALSE)

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.

cache

(logical) flag indicating if the status of the instances will be stored after each pipe. This allows to avoid rejections of previously executed tasks, if the order and configuration of the pipe and pipeline is the same as what is stored in the cache.

verbose

(logical) flag indicating for printing messages, warnings and errors.

summary

(logical) flag indicating if a summary of the pipeline execution is provided or not.

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 thought bdpar.Options variable which have different methods to support the functionality 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)

#If it is neccesary parallelize, do it through:
#bdpar.Options$set("numCores", numCores)

#If it is necessary to change the behavior of the log, do it through:
#bdpar.Options$configureLog(console = TRUE, threshold = "INFO", file = NULL)

#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,
            cache = FALSE,
            verbose = FALSE,
            summary = TRUE)

## End(Not run)

[Package bdpar version 3.0.0 Index]