Skip to contents

Filter Activity Presence

Source: R/filter_activity_presence.R
filter_activity_presence.Rd

Filters cases based on the presence (or absence) of activities.

Usage

filter_activity_presence(
  log,
  activities = NULL,
  method = c("all", "none", "one_of", "exact", "only"),
  reverse = FALSE,
  eventlog = deprecated()
)

# S3 method for class 'log'
filter_activity_presence(
  log,
  activities = NULL,
  method = c("all", "none", "one_of", "exact", "only"),
  reverse = FALSE,
  eventlog = deprecated()
)

# S3 method for class 'grouped_log'
filter_activity_presence(
  log,
  activities = NULL,
  method = c("all", "none", "one_of", "exact", "only"),
  reverse = FALSE,
  eventlog = deprecated()
)

Arguments

log

log: Object of class log or derivatives (grouped_log, eventlog, activitylog, etc.).

activities

character vector: Containing one or more activity 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.

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 functions allows to filter cases that contain certain activities. It requires as input a vector containing one or more activity labels and it has a method argument with following options:

  • "all" means that all the specified activity labels must be present for a case 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 activities can be present (although multiple times and in random orderings).

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

When only one activity label is supplied, note that methods "all" and "one_of" will be identical.

Methods (by class)

  • filter_activity_presence(log): Filters activities for a log.

  • filter_activity_presence(grouped_log): Filters activities for a grouped_log.

References

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

See also

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