Skip to contents

Idle Time

Source: R/idle_time.R
idle_time.Rd

Calculates the amount of time that no activity occurs.

Usage

idle_time(
  log,
  level = c("log", "trace", "case", "resource"),
  append = deprecated(),
  append_column = NULL,
  units = c("auto", "secs", "mins", "hours", "days", "weeks"),
  sort = TRUE,
  eventlog = deprecated()
)

# S3 method for eventlog
idle_time(
  log,
  level = c("log", "trace", "case", "resource"),
  append = deprecated(),
  append_column = NULL,
  units = c("auto", "secs", "mins", "hours", "days", "weeks"),
  sort = TRUE,
  eventlog = deprecated()
)

# S3 method for grouped_eventlog
idle_time(
  log,
  level = c("log", "case", "trace", "resource"),
  append = deprecated(),
  append_column = NULL,
  units = c("auto", "secs", "mins", "hours", "days", "weeks"),
  sort = TRUE,
  eventlog = deprecated()
)

# S3 method for activitylog
idle_time(
  log,
  level = c("log", "trace", "case", "resource"),
  append = deprecated(),
  append_column = NULL,
  units = c("auto", "secs", "mins", "hours", "days", "weeks"),
  sort = TRUE,
  eventlog = deprecated()
)

# S3 method for grouped_activitylog
idle_time(
  log,
  level = c("log", "trace", "case", "resource"),
  append = deprecated(),
  append_column = NULL,
  units = c("auto", "secs", "mins", "hours", "days", "weeks"),
  sort = TRUE,
  eventlog = deprecated()
)

Arguments

log

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

level

character (default "log"): Level of granularity for the analysis: "log" (default), "trace", "case", or "resource". For more information, see vignette("metrics", "edeaR") and Details below.

append

logical (default FALSE) [Deprecated]: The arguments append and append_column have been deprecated in favour of augment.
Indicating whether to append results to original log. Ignored when level is "log" or "trace".

append_column

[Deprecated] The arguments append and append_column have been deprecated in favour of augment.
Which of the output columns to append to log, if append = TRUE. Default column depends on chosen level.

units

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

sort

logical (default TRUE): Sort by decreasing idle time. Only relevant for "trace" and "resource" level.

eventlog

[Deprecated]; please use log instead.

Details

Argument level has the following options:

  • At "log" level, the idle time metric provides an overview of summary statistics of the idle time per case, aggregated over the complete log.

  • On "trace" level, the idle time metric provides an overview of the summary statistics of the idle time for each trace in the log.

  • On "case" level, the idle time metric provides an overview of the total idle time per case

  • On "resource" level, this metric can be used to get an insight in the amount of time each resource "wastes" during the process.

Methods (by class)

  • idle_time(eventlog): Computes the idle time for an eventlog.

  • idle_time(grouped_eventlog): Computes the idle time for a grouped_eventlog.

  • idle_time(activitylog): Computes the idle time for an activitylog.

  • idle_time(grouped_activitylog): Computes the idle time for a grouped_activitylog.

References

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

See also

throughput_time(),processing_time(),difftime()

Other metrics: activity_frequency(), activity_presence(), end_activities(), number_of_repetitions(), number_of_selfloops(), number_of_traces(), processing_time(), resource_frequency(), resource_involvement(), resource_specialisation(), start_activities(), throughput_time(), trace_coverage(), trace_length()