Skip to contents

Trace Coverage

Source: R/trace_coverage.R
trace_coverage.Rd

Analyses the structuredness of a log by use of trace frequencies.

Usage

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

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

# S3 method for class 'grouped_log'
trace_coverage(
  log,
  level = c("log", "trace", "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", or "case". 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, summary statistics of the coverage of traces are returned.

  • On "trace" level, the absolute and relative frequency of each trace are returned.

  • On "case" level, the coverage of the corresponding trace is returned for each case.

Methods (by class)

  • trace_coverage(log): Calculates trace coverage metric for a log.

  • trace_coverage(grouped_log): Calculates trace coverage metric for a grouped_log.

References

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

See also

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