Skip to contents

Filter Life Cycle Presence

Source: R/filter_lifecycle_presence.R
filter_lifecycle_presence.Rd

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

Usage

filter_lifecycle_presence(
  log,
  lifecycles,
  method = c("all", "none", "one_of", "exact", "only"),
  reverse = FALSE,
  lifecycle = deprecated(),
  eventlog = deprecated()
)

# S3 method for class 'eventlog'
filter_lifecycle_presence(
  log,
  lifecycles,
  method = c("all", "none", "one_of", "exact", "only"),
  reverse = FALSE,
  lifecycle = deprecated(),
  eventlog = deprecated()
)

# S3 method for class 'grouped_eventlog'
filter_lifecycle_presence(
  log,
  lifecycles,
  method = c("all", "none", "one_of", "exact", "only"),
  reverse = FALSE,
  lifecycle = deprecated(),
  eventlog = deprecated()
)

Arguments

log

eventlog: Object of class eventlog or derivatives (grouped_eventlog).

lifecycles

character vector: A vector of life cycle identifiers.

method

character (default "all"): Filter method: "all" (default), "none", "one_of", "exact", or "only". For more information, see Details below.

reverse

logical (default FALSE): Indicating whether the selection should be reversed.

lifecycle

[Deprecated]; please use lifecycles instead.

eventlog

[Deprecated]; please use log instead.

Value

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

Details

This function 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 with following options:

  • "all" 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.

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

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

Methods (by class)

  • filter_lifecycle_presence(eventlog): Filters activity instances on the presence of life cycle labels for an eventlog.

  • filter_lifecycle_presence(grouped_eventlog): Filters activity instances on the presence of life cycle labels for a grouped_eventlog.

References

Swennen, M. (2018). Using Event Log Knowledge to Support Operational Exellence Techniques (Doctoral dissertation). Hasselt University.

See also

lifecycle_id

Other filters: filter_activity_frequency(), filter_activity_instance(), filter_activity_presence(), filter_activity(), filter_case_condition(), filter_case(), filter_endpoints_condition(), filter_endpoints(), filter_flow_time(), filter_idle_time(), filter_infrequent_flows(), filter_lifecycle(), filter_precedence_condition(), filter_precedence_resource(), filter_precedence(), filter_processing_time(), filter_resource_frequency(), filter_resource(), filter_throughput_time(), filter_time_period(), filter_trace_frequency(), filter_trace_length(), filter_trace(), filter_trim_lifecycle(), filter_trim()