filter_idle_time: Filter Idle Time

View source: R/filter_idle_time.R

filter_idle_timeR Documentation

Filter Idle Time

Description

Filters cases based on their idle_time.

This filter can be used by using an interval or by using a percentage. The percentage will always start with the cases with the lowest idle time first and stop including cases when the specified percentile is reached. On the other hand, an absolute interval can be defined instead to filter cases which have an idle time in this interval. The time units in which this interval is defined can be supplied with the units argument.

Usage

filter_idle_time(
  log,
  interval = NULL,
  percentage = NULL,
  reverse = FALSE,
  units = c("secs", "mins", "hours", "days", "weeks")
)

## S3 method for class 'log'
filter_idle_time(
  log,
  interval = NULL,
  percentage = NULL,
  reverse = FALSE,
  units = c("secs", "mins", "hours", "days", "weeks")
)

## S3 method for class 'grouped_log'
filter_idle_time(
  log,
  interval = NULL,
  percentage = NULL,
  reverse = FALSE,
  units = c("secs", "mins", "hours", "days", "weeks")
)

Arguments

log

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

interval, percentage

Provide either interval or percentage.
interval (numeric vector of length 2): A duration interval. Half open interval can be created using NA.
percentage (numeric): A percentage to be used for relative filtering.

reverse

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

units

character (default "secs"): The time unit in which the processing times should be reported. Should be one of the following values: "secs" (default), "mins", "hours", "days", "weeks". See also the units argument of difftime().

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.

Methods (by class)

  • filter_idle_time(log): Filters cases for a log.

  • filter_idle_time(grouped_log): Filters cases for a grouped_log.

References

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

See Also

idle_time(),difftime()

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_infrequent_flows(), filter_lifecycle_presence(), 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()


edeaR documentation built on April 27, 2023, 9:07 a.m.