Learn R Programming

edeaR (version 0.8.3)

filter_lifecycle_presence: Filter: Life cycle Presence

Description

Filters activity instances based on the presence (or absence) of life cycles

Usage

filter_lifecycle_presence(eventlog, lifecycle, method, reverse)

# S3 method for eventlog filter_lifecycle_presence(eventlog, lifecycle = NULL, method = c("all", "one_of", "none", "exact", "only"), reverse = FALSE)

# S3 method for grouped_eventlog filter_lifecycle_presence(eventlog, lifecycle = NULL, method = c("all", "one_of", "none", "exact", "only"), reverse = FALSE)

ifilter_lifecycle_presence(eventlog)

Arguments

eventlog

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

lifecycle

Character vector containing one or more life cycle identifiers.

method

Filter method. If "all", each of the life cycle labels should be present. If "one_of", at least one of them should be present. If "none", none of the life cycle labels are allowed to occur in the filtered activity instances.

reverse

Logical, indicating whether the selection should be reversed.

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)

  • eventlog: Filter event log on presence of life cycle labels.

  • grouped_eventlog: Filter grouped event log on presence of life cycle labels.

Details

This functions allows to filter activity instances that (do not) contain certain life cycle identifiers. It requires as input a vector containing one or more life cycle labels and it has a method argument. The latter can have the values all, none or one_of.

  • When set to `all`, it means that all the specified life cycle labels must be present for an activity instance to be selected

  • `none` means that they are not allowed to be present.

  • `one_of` means that at least one of them must be present.

  • `only` means that only (a set of) these life cycle labels are allowed to be present

  • `exact` means that only exactly these life cycle labels can be present (although multiple times and in random orderings)

See Also

vignette("filters", "edeaR")