filter_trim_lifecycle: Filter: Trim activity instances based on life cycle labels

Description Usage Arguments Details Value Methods (by class) See Also

View source: R/filter_lifecycle_trim.R

Description

Trim activity instances from the first event of a set of start life cycle labels to the last event of a set of end life cycle labels

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
filter_trim_lifecycle(eventlog, start_lifecycle, end_lifecycle, reverse)

## S3 method for class 'eventlog'
filter_trim_lifecycle(eventlog,
  start_lifecycle = NULL, end_lifecycle = NULL, reverse = FALSE)

## S3 method for class 'grouped_eventlog'
filter_trim_lifecycle(eventlog,
  start_lifecycle = NULL, end_lifecycle = NULL, reverse = FALSE)

ifilter_trim_lifecycle(eventlog)

Arguments

eventlog

The dataset to be used. Should be a (grouped) eventlog object.

start_lifecycle

A vector of life cycle identifiers, or NULL

end_lifecycle

A vector of life cycle identifiers, or NULL

reverse

Logical, indicating whether the selection should be reversed.

Details

One can trim activity instances by removing one or more events at the start and/or end of the activity instances. Trimming is performed until all activity instances have a start and/or end point belonging to a set of allowed life cycle labels. This filter requires a set of allowed start life cycle labels and/or a set of allowed life cycle labels. If one of them is not provided it will not trim the activity instances at this edge.The selection can be reversed, which means that only the trimmed events at the start and end of activity instances are retained. As such, this argument allows to cut intermediate parts out of activity instances.

Value

When given an eventlog, it will return a filtered eventlog. When given a grouped eventlog, the filter will be applied in a stratified way (i.e. each separately for each group). The returned eventlog will be grouped on the same variables as the original event log.

Methods (by class)

See Also

vignette("filters", "edeaR")


gertjanssenswillen/edeaR documentation built on July 22, 2019, 7:08 p.m.