Skip to contents

Provides summary statistics about the frequency of activity types at the level of log, traces, cases, activity types.

Usage

activity_frequency(
  log,
  level = c("log", "trace", "activity", "case"),
  append = deprecated(),
  append_column = NULL,
  sort = TRUE,
  eventlog = deprecated()
)

# S3 method for eventlog
activity_frequency(
  log,
  level = c("log", "trace", "activity", "case"),
  append = deprecated(),
  append_column = NULL,
  sort = TRUE,
  eventlog = deprecated()
)

# S3 method for grouped_eventlog
activity_frequency(
  log,
  level = c("log", "trace", "activity", "case"),
  append = deprecated(),
  append_column = NULL,
  sort = TRUE,
  eventlog = deprecated()
)

# S3 method for activitylog
activity_frequency(
  log,
  level = c("log", "trace", "activity", "case"),
  append = deprecated(),
  append_column = NULL,
  sort = TRUE,
  eventlog = deprecated()
)

# S3 method for grouped_activitylog
activity_frequency(
  log,
  level = c("log", "trace", "activity", "case"),
  append = deprecated(),
  append_column = NULL,
  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 "activity". 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.

sort

logical (default TRUE): Sort output on count. Only for levels with frequency count output.

eventlog

[Deprecated]; please use log instead.

Details

Argument level has the following options:

  • At log level, this metric shows the summary statistics of the frequency of activities throughout the complete log.

  • On case level, this metric shows the absolute and relative number of times the different activity types occur in each case. The absolute number shows the number of distinct activity types that occur in each of the cases. The relative number is calculated based on the total activity executions in the case.

  • On trace level, this metric presents the absolute and relative number of times a specific activity type occurs in each trace.

  • On activity level, this metric provides the absolute and relative frequency of a specific activity in the complete log.

Methods (by class)

  • activity_frequency(eventlog): Computes the activity frequency for an eventlog.

  • activity_frequency(grouped_eventlog): Computes the activity frequency for a grouped_eventlog.

  • activity_frequency(activitylog): Computes the activity frequency for an activitylog.

  • activity_frequency(grouped_activitylog): Computes the activity frequency for a grouped_activitylog.

References

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