Segment: Segment
In makepipe: Pipeline Tools Inspired by 'GNU Make'
Segment R Documentation
Segment
Description
A Segment object is automatically constructed and attached to
the Pipeline when a call to make_*() is made. It stores the relationships
between targets, dependencies, and sources.
Public fields
targetsA character vector of paths to files
dependenciesA character vector of paths to files which the targets
depend on
packagesA character vector of names of packages which targets
depend on
forceA logical determining whether or not execution of the source
or recipe will be forced (i.e. happen whether or not the targets are
out-of-date)
envirThe environment in which to execute the instructions.
resultAn object, whatever is returned by executing the instructions
executedA logical, whether or not the instructions were executed
execution_timeA difftime, the time taken to execute the instructions
labelA short label for the segment
noteA description of what the segment does
Active bindings
edgesGet edges connecting the dependencies, instructions, and targets
nodesGet nodes corresponding to dependencies, instructions, and targets
text_summaryA plain text summary of the Segment
Methods
Public methods
Method new()
Initialise a new Segment
Usage
Segment$new(
id,
targets,
dependencies,
packages,
envir,
force,
executed,
result,
execution_time
)
Arguments
idAn integer that uniquely identifies the segment
targetsA character vector of paths to files
dependenciesA character vector of paths to files which the targets
depend on
packagesA character vector of names of packages which targets
depend on
envirThe environment in which to execute the instructions.
forceA logical determining whether or not execution of the source
or recipe will be forced (i.e. happen whether or not the targets are
out-of-date)
executedA logical, whether or not the instructions were executed
resultAn object, whatever is returned by executing the instructions
execution_timeA difftime, the time taken to execute the instructions
Method print()
Printing method
Usage
Segment$print()
Method update_result()
Update the Segment with new execution information
Usage
Segment$update_result(executed, execution_time, result)
Arguments
executedA logical, whether or not the instructions were executed
execution_timeA difftime, the time taken to execute the instructions
resultAn object, whatever is returned by executing the instructions
Method annotate()
Apply annotations to Segment
Usage
Segment$annotate(label = NULL, note = NULL)
Arguments
labelA short label for the segment
noteA description of what the segment does
Method clone()
The objects of this class are cloneable with this method.
Usage
Segment$clone(deep = FALSE)
Arguments
deepWhether to make a deep clone.
See Also
Other segment:
SegmentRecipe,
SegmentSource
makepipe documentation built on Dec. 7, 2022, 5:16 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| Segment | R Documentation |
Segment
Description
A Segment object is automatically constructed and attached to
the Pipeline when a call to make_*() is made. It stores the relationships
between targets, dependencies, and sources.
Public fields
targetsA character vector of paths to files
dependenciesA character vector of paths to files which the
targetsdepend onpackagesA character vector of names of packages which
targetsdepend onforceA logical determining whether or not execution of the
sourceorrecipewill be forced (i.e. happen whether or not the targets are out-of-date)envirThe environment in which to execute the instructions.
resultAn object, whatever is returned by executing the instructions
executedA logical, whether or not the instructions were executed
execution_timeA difftime, the time taken to execute the instructions
labelA short label for the segment
noteA description of what the segment does
Active bindings
edgesGet edges connecting the dependencies, instructions, and targets
nodesGet nodes corresponding to dependencies, instructions, and targets
text_summaryA plain text summary of the Segment
Methods
Public methods
Method new()
Initialise a new Segment
Usage
Segment$new( id, targets, dependencies, packages, envir, force, executed, result, execution_time )
Arguments
idAn integer that uniquely identifies the segment
targetsA character vector of paths to files
dependenciesA character vector of paths to files which the
targetsdepend onpackagesA character vector of names of packages which
targetsdepend onenvirThe environment in which to execute the instructions.
forceA logical determining whether or not execution of the
sourceorrecipewill be forced (i.e. happen whether or not the targets are out-of-date)executedA logical, whether or not the instructions were executed
resultAn object, whatever is returned by executing the instructions
execution_timeA difftime, the time taken to execute the instructions
Method print()
Printing method
Usage
Segment$print()
Method update_result()
Update the Segment with new execution information
Usage
Segment$update_result(executed, execution_time, result)
Arguments
executedA logical, whether or not the instructions were executed
execution_timeA difftime, the time taken to execute the instructions
resultAn object, whatever is returned by executing the instructions
Method annotate()
Apply annotations to Segment
Usage
Segment$annotate(label = NULL, note = NULL)
Arguments
labelA short label for the segment
noteA description of what the segment does
Method clone()
The objects of this class are cloneable with this method.
Usage
Segment$clone(deep = FALSE)
Arguments
deepWhether to make a deep clone.
See Also
Other segment:
SegmentRecipe,
SegmentSource
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.