Type: Package
Title: Exploratory and Descriptive Event-Based Data Analysis
Version: 0.9.5
Description: Exploratory and descriptive analysis of event based data. Provides methods for describing and selecting process data, and for preparing event log data for process mining. Builds on the S3-class for event logs implemented in the package 'bupaR'.
License: MIT + file LICENSE
Depends: R(≥ 3.5.0)
Imports: bupaR (≥ 0.5.1), dplyr, data.table, ggplot2, ggthemes, glue, tibble, shiny, miniUI, tidyr, shinyTime, lubridate, purrr, stringr, rlang (≥ 1.0.0), cli (≥ 3.2.0), zoo, hms, lifecycle, magrittr
Encoding: UTF-8
RoxygenNote: 7.3.2
URL: https://bupar.net/, https://github.com/bupaverse/edeaR/, https://bupaverse.github.io/edeaR/
Suggests: knitr, eventdataR, rmarkdown, covr, testthat (≥ 3.0.0)
VignetteBuilder: knitr
BugReports: https://github.com/bupaverse/edeaR/issues/
Config/testthat/edition: 3
NeedsCompilation: no
Packaged: 2025-07-07 13:33:41 UTC; lucp8407
Author: Gert Janssenswillen [aut, cre], Gerard van Hulzen [ctb], Marijke Swennen [ctb], Ivan Esin [ctb], Hasselt University [cph]
Maintainer: Gert Janssenswillen <gert.janssenswillen@uhasselt.be>
Repository: CRAN
Date/Publication: 2025-07-09 13:40:02 UTC

edeaR - Exploratory and Descriptive Event-based data Analysis in R

Description

This package provides several useful techniques for Exploratory and Descriptive analysis of event based data in R, developed by the Business Informatics Research Group of Hasselt University.

Author(s)

Maintainer: Gert Janssenswillen gert.janssenswillen@uhasselt.be

Other contributors:

See Also

Useful links:


Activity Frequency

Description

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 class 'eventlog'
activity_frequency(
  log,
  level = c("log", "trace", "activity", "case"),
  append = deprecated(),
  append_column = NULL,
  sort = TRUE,
  eventlog = deprecated()
)

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

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

## S3 method for class '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:

Methods (by class)

References

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

See Also

Other metrics: 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_coverage(), trace_length()


Metric: Activity Presence

Description

Calculates for each activity type in what percentage of cases it is present.

Usage

activity_presence(
  log,
  append = deprecated(),
  append_column = NULL,
  sort = TRUE,
  eventlog = deprecated()
)

## S3 method for class 'eventlog'
activity_presence(
  log,
  append = deprecated(),
  append_column = NULL,
  sort = TRUE,
  eventlog = deprecated()
)

## S3 method for class 'grouped_eventlog'
activity_presence(
  log,
  append = deprecated(),
  append_column = NULL,
  sort = TRUE,
  eventlog = deprecated()
)

## S3 method for class 'activitylog'
activity_presence(
  log,
  append = deprecated(),
  append_column = NULL,
  sort = TRUE,
  eventlog = deprecated()
)

## S3 method for class 'grouped_activitylog'
activity_presence(
  log,
  append = deprecated(),
  append_column = NULL,
  sort = TRUE,
  eventlog = deprecated()
)

Arguments

log

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

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

An indication of variance can be the presence of the activities in the different cases. This metric shows for each activity the absolute number of cases in which each activity occurs together with its relative presence.

Methods (by class)

References

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

See Also

Other metrics: activity_frequency(), 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_coverage(), trace_length()

Examples

## Not run: 
data <- data.frame(case = rep("A",5),
activity_id = c("A","B","C","D","E"),
activity_instance_id = 1:5,
lifecycle_id = rep("complete",5),
timestamp = 1:5,
resource = rep("resource 1", 5))

log <- bupaR::eventlog(data,case_id = "case",
activity_id = "activity_id",
activity_instance_id = "activity_instance_id",
lifecycle_id = "lifecycle_id",
timestamp = "timestamp",
resource_id = "resource")

activity_presence(log)

## End(Not run)


Add fixed holiday to work schedule

Description

Add fixed holiday to work schedule

Usage

add_fixed_holiday(work_schedule, name, month, day)

Arguments

work_schedule

Work schedule created with create_work_schedule

name

Name of holiday

month

Month in which fixed holiday takes place

day

Day of fixed holiday


Add floating holiday to work schedule

Description

Add floating holiday to work schedule

Usage

add_floating_holiday(work_schedule, name, dates)

Arguments

work_schedule

Work schedule created with create_work_schedule

name

Name of holiday

dates

Dates of floating holiday. Make sure to list all dates relevant to your time frame


Add holiday period to work schedule

Description

Add holiday period to work schedule

Usage

add_holiday_periods(work_schedule, from, to)

Arguments

work_schedule

Work schedule created with create_work_schedule

from

Start of holiday period (included)

to

End of holiday period (included)


Augment Log

Description

Augment log with results from metric computation.

Usage

augment(metric, log, columns, prefix = "")

## S3 method for class 'log_metric'
augment(metric, log, columns, prefix = "")

## S3 method for class 'case_metric'
augment(metric, log, columns, prefix = "")

## S3 method for class 'activity_metric'
augment(metric, log, columns, prefix = "")

## S3 method for class 'resource_metric'
augment(metric, log, columns, prefix = "")

## S3 method for class 'resource_activity_metric'
augment(metric, log, columns, prefix = "")

## S3 method for class 'trace_metric'
augment(metric, log, columns, prefix = "")

Arguments

metric

Metric computed by edeaR

log

log: Object of class log or derivatives (grouped_log, eventlog, activitylog, etc.) that was used to compute the metric.

columns

character vector: Column names from the metric that you want to add to the log. If missing, defaults to all columns.

prefix

character: Prefix to be added to the newly added metric columns in the log.

Value

Object of class log or derivatives (grouped_log, eventlog, activitylog, etc.). Same class as the log input.

Methods (by class)

Examples

## Not run: 
sepsis %>%
	throughput_time("case") %>%
	augment(sepsis)

## End(Not run)


Calculate queuing length

Description

[Experimental]

Usage

calculate_queuing_length(
  queueing_times,
  level = c("log", "activity", "resource"),
  time_interval
)

Arguments

queueing_times

Object of class queuing_times, returned by calculate_queuing_times.

level

character (default "log"): Level of granularity for the analysis: "log", "activity", "resource". For more information, see 'Details' below.

time_interval

The time interval after which the queue length should be calculated. For more information, see 'Details' below and the by argument of seq.Date.

Details

Argument level has the following options:

Argument time_interval has the following options (see also the by argument of seq.Date):

See Also

calculate_queuing_times, seq.Date


Calculate queuing times

Description

[Experimental]

Usage

calculate_queuing_times(
  log,
  units = c("auto", "secs", "mins", "hours", "days", "weeks"),
  eventlog = deprecated()
)

## S3 method for class 'eventlog'
calculate_queuing_times(
  log,
  units = c("auto", "secs", "mins", "hours", "days", "weeks"),
  eventlog = deprecated()
)

## S3 method for class 'activitylog'
calculate_queuing_times(
  log,
  units = c("auto", "secs", "mins", "hours", "days", "weeks"),
  eventlog = deprecated()
)

Arguments

log

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

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.

eventlog

[Deprecated]; please use log instead.

Value

Returns a list of all the activity instances, with the time they started, and the time since they were queued. Notice that this does not take into account any process model notion! The time since they are queued is the completion time of the previous activity in the log.

Methods (by class)

References

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

See Also

difftime


Adjust days in work schedule

Description

Adjust days in work schedule

Usage

change_day(work_schedule, day, start_time, end_time)

Arguments

work_schedule

Work schedule created with create_work_schedule

day

A numeric vector containing the days to be changed. 1 = monday.

start_time

The new start time for selected days (hh:mm:ss)

end_time

The new end time for selected days (hh:mm:ss)


Create work schedule

Description

Create work schedule

Usage

create_work_schedule(start_time = "9:00:00", end_time = "17:00:00")

Arguments

start_time

Character indicating the usual start time for workdays (hh:mm:ss)

end_time

Character indicating the usual end time for workdays (hh:mm:ss)


End activities

Description

Analyse the end activities in the process.

Usage

end_activities(
  log,
  level = c("log", "case", "activity", "resource", "resource-activity"),
  append = deprecated(),
  append_column = NULL,
  sort = TRUE,
  eventlog = deprecated()
)

## S3 method for class 'eventlog'
end_activities(
  log,
  level = c("log", "case", "activity", "resource", "resource-activity"),
  append = deprecated(),
  append_column = NULL,
  sort = TRUE,
  eventlog = deprecated()
)

## S3 method for class 'grouped_eventlog'
end_activities(
  log,
  level = c("log", "case", "activity", "resource", "resource-activity"),
  append = deprecated(),
  append_column = NULL,
  sort = TRUE,
  eventlog = deprecated()
)

## S3 method for class 'activitylog'
end_activities(
  log,
  level = c("log", "case", "activity", "resource", "resource-activity"),
  append = deprecated(),
  append_column = NULL,
  sort = TRUE,
  eventlog = deprecated()
)

## S3 method for class 'grouped_activitylog'
end_activities(
  log,
  level = c("log", "case", "activity", "resource", "resource-activity"),
  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), "case", "activity", "resource", or "resource-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:

Methods (by class)

References

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

See Also

start_activities

Other metrics: activity_frequency(), activity_presence(), idle_time(), 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()


Filter Activity

Description

Filters the log based on activities

Usage

filter_activity(log, activities, reverse = FALSE, eventlog = deprecated())

## S3 method for class 'log'
filter_activity(log, activities, reverse = FALSE, eventlog = deprecated())

## S3 method for class 'grouped_log'
filter_activity(log, activities, 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.

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.

Methods (by class)

References

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

See Also

vignette("filters", "edeaR")

Other filters: filter_activity_frequency(), filter_activity_instance(), filter_activity_presence(), 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()


Filter Activity Frequency

Description

Filters the log based on frequency of activities.

Usage

filter_activity_frequency(
  log,
  interval = NULL,
  percentage = NULL,
  reverse = FALSE,
  eventlog = deprecated()
)

## S3 method for class 'log'
filter_activity_frequency(
  log,
  interval = NULL,
  percentage = NULL,
  reverse = FALSE,
  eventlog = deprecated()
)

## S3 method for class 'grouped_log'
filter_activity_frequency(
  log,
  interval = NULL,
  percentage = NULL,
  reverse = FALSE,
  eventlog = deprecated()
)

Arguments

log

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

percentage, interval

The target coverage of activity instances. Provide either percentage or interval.
percentage (numeric): A percentile of p will return the most common activity types of the log, which account for at least p% of the activity instances.
interval (numeric vector of length 2): An activity frequency interval. Half open interval can be created using NA.
For more information, see 'Details' below.

reverse

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

eventlog

[Deprecated]; please use log instead.

Details

Filtering the log based on activity frequency can be done in two ways: using an interval of allowed frequencies, or specify a coverage percentage:

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)

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_instance(), filter_activity_presence(), 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()


Filter Activity Instance

Description

Filters the log based on activity instance identifier. This method has an activity_instances argument, to which a vector of identifiers can be given. The selection can be negated with the reverse argument.

Usage

filter_activity_instance(
  log,
  activity_instances,
  reverse = FALSE,
  eventlog = deprecated()
)

## S3 method for class 'eventlog'
filter_activity_instance(
  log,
  activity_instances,
  reverse = FALSE,
  eventlog = deprecated()
)

## S3 method for class 'grouped_eventlog'
filter_activity_instance(
  log,
  activity_instances,
  reverse = FALSE,
  eventlog = deprecated()
)

Arguments

log

eventlog: Object of class eventlog or derivatives (grouped_eventlog).

activity_instances

A vector of activity instance identifiers.

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.

Methods (by class)

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_presence(), 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()


Filter Activity Presence

Description

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.

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:

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

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)

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()


Filter Case

Description

Filters the log based on case identifier. This method has a cases argument, to which a vector of identifiers can be given. The selection can be negated with the reverse argument.

Usage

filter_case(log, cases, reverse = FALSE, eventlog = deprecated())

## S3 method for class 'log'
filter_case(log, cases, reverse = FALSE, eventlog = deprecated())

## S3 method for class 'grouped_log'
filter_case(log, cases, reverse = FALSE, eventlog = deprecated())

Arguments

log

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

cases

character vector: A vector of cases identifiers.

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.

Methods (by class)

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_activity_presence(), 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()


Filter Case Condition

Description

Filters cases using a condition. Only keeps cases if the condition is valid for at least one event.

Usage

filter_case_condition(log, ..., reverse = FALSE)

## S3 method for class 'log'
filter_case_condition(log, ..., reverse = FALSE)

## S3 method for class 'grouped_log'
filter_case_condition(log, ..., reverse = FALSE)

Arguments

log

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

...

Expressions that return a logical value, and are defined in terms of the variables in log. If multiple expressions are included, they are combined with the & operator. Only rows for which all conditions evaluate to TRUE are kept. For more information, see filter.

reverse

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

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)

References

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

See Also

filter

Other filters: filter_activity(), filter_activity_frequency(), filter_activity_instance(), filter_activity_presence(), filter_case(), 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()


Filter Start and End Activities

Description

Filters the log based on a provided set of start and end activities

The filter_endpoints method filters cases based on the first and last activity label. It can be used in two ways: by specifying vectors with allowed start activities and/or allowed end activities, or by specifying a percentile. In the latter case, the percentile value will be used as a cut off. For example, when set to 0.9, it will select the most common endpoint pairs which together cover at least 90% of the cases, and filter the log accordingly.

Usage

filter_endpoints(
  log,
  start_activities = NULL,
  end_activities = NULL,
  percentage = NULL,
  reverse = FALSE,
  eventlog = deprecated()
)

## S3 method for class 'log'
filter_endpoints(
  log,
  start_activities = NULL,
  end_activities = NULL,
  percentage = NULL,
  reverse = FALSE,
  eventlog = deprecated()
)

## S3 method for class 'grouped_log'
filter_endpoints(
  log,
  start_activities = NULL,
  end_activities = NULL,
  percentage = NULL,
  reverse = FALSE,
  eventlog = deprecated()
)

Arguments

log

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

start_activities, end_activities

character vector (default NULL): A vector of activity identifiers, or NULL.

percentage

numeric (default NULL): A percentage p to be used as percentile cut off. When this is used, the most common endpoint-pairs will be selected until at least the p% of the cases are selected.

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.

Methods (by class)

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_activity_presence(), filter_case(), filter_case_condition(), 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()


Filter Start and End Conditions

Description

Filters cases where the first and/or last activity adhere to the specified conditions.

Usage

filter_endpoints_condition(
  log,
  start_condition = NULL,
  end_condition = NULL,
  reverse = FALSE,
  eventlog = deprecated()
)

## S3 method for class 'eventlog'
filter_endpoints_condition(
  log,
  start_condition = NULL,
  end_condition = NULL,
  reverse = FALSE,
  eventlog = deprecated()
)

## S3 method for class 'grouped_log'
filter_endpoints_condition(
  log,
  start_condition = NULL,
  end_condition = NULL,
  reverse = FALSE,
  eventlog = deprecated()
)

## S3 method for class 'activitylog'
filter_endpoints_condition(
  log,
  start_condition = NULL,
  end_condition = NULL,
  reverse = FALSE,
  eventlog = deprecated()
)

filter_endpoints_conditions(
  log,
  start_condition = NULL,
  end_condition = NULL,
  reverse = FALSE,
  eventlog = deprecated()
)

Arguments

log

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

start_condition, end_condition

A logical condition.

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.

Methods (by class)

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_activity_presence(), filter_case(), filter_case_condition(), filter_endpoints(), 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()


Filter directly follows with time interval

Description

Filter cases where the activity from is followed by activity to within a certain time interval.

Usage

filter_flow_time(
  log,
  from,
  to,
  interval,
  reverse = FALSE,
  units = c("secs", "mins", "hours", "days", "weeks")
)

## S3 method for class 'log'
filter_flow_time(
  log,
  from,
  to,
  interval,
  reverse = FALSE,
  units = c("secs", "mins", "hours", "days", "weeks")
)

## S3 method for class 'grouped_log'
filter_flow_time(
  log,
  from,
  to,
  interval,
  reverse = FALSE,
  units = c("secs", "mins", "hours", "days", "weeks")
)

Arguments

log

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

from, to

character vector of length 1: The antecendent and consequent to filter on. Both are character vectors containing exactly one activity identifier.

interval

numeric vector of length 2: A duration interval. Half open interval can be created using NA.

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)

References

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

See Also

processing_time(),difftime()

Other filters: filter_activity(), filter_activity_frequency(), filter_activity_instance(), filter_activity_presence(), filter_case(), filter_case_condition(), filter_endpoints(), filter_endpoints_condition(), 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()


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)

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(), filter_activity_frequency(), filter_activity_instance(), filter_activity_presence(), filter_case(), filter_case_condition(), filter_endpoints(), filter_endpoints_condition(), filter_flow_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()


Filter Infrequent Flows

Description

[Experimental]

Filter cases based on infrequent flows.

Usage

filter_infrequent_flows(log, min_n = 2, eventlog = deprecated())

## S3 method for class 'eventlog'
filter_infrequent_flows(log, min_n = 2, eventlog = deprecated())

## S3 method for class 'grouped_eventlog'
filter_infrequent_flows(log, min_n = 2, eventlog = deprecated())

## S3 method for class 'activitylog'
filter_infrequent_flows(log, min_n = 2, eventlog = deprecated())

## S3 method for class 'grouped_activitylog'
filter_infrequent_flows(log, min_n = 2, eventlog = deprecated())

Arguments

log

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

min_n

numeric (default 2): Cases containing a flow that occurs less than min_n times are discarded.

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.

Methods (by class)

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_activity_presence(), filter_case(), filter_case_condition(), filter_endpoints(), filter_endpoints_condition(), filter_flow_time(), filter_idle_time(), 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()


Filter Life Cycle

Description

Filters the log based on the life cycle identifier.

Usage

filter_lifecycle(
  log,
  lifecycles,
  reverse = FALSE,
  lifecycle = deprecated(),
  eventlog = deprecated()
)

## S3 method for class 'eventlog'
filter_lifecycle(
  log,
  lifecycles,
  reverse = FALSE,
  lifecycle = deprecated(),
  eventlog = deprecated()
)

## S3 method for class 'grouped_eventlog'
filter_lifecycle(
  log,
  lifecycles,
  reverse = FALSE,
  lifecycle = deprecated(),
  eventlog = deprecated()
)

Arguments

log

eventlog: Object of class eventlog or derivatives (grouped_eventlog).

lifecycles

character vector: A vector of life cycle identifiers.

reverse

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

lifecycle

[Deprecated]; please use lifecycles instead.

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.

Methods (by class)

References

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

See Also

lifecycle_id

Other filters: filter_activity(), filter_activity_frequency(), filter_activity_instance(), filter_activity_presence(), filter_case(), filter_case_condition(), filter_endpoints(), filter_endpoints_condition(), filter_flow_time(), filter_idle_time(), filter_infrequent_flows(), 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()


Filter Life Cycle Presence

Description

Filters activity instances based on the presence (or absence) of life cycles.

Usage

filter_lifecycle_presence(
  log,
  lifecycles,
  method = c("all", "none", "one_of", "exact", "only"),
  reverse = FALSE,
  lifecycle = deprecated(),
  eventlog = deprecated()
)

## S3 method for class 'eventlog'
filter_lifecycle_presence(
  log,
  lifecycles,
  method = c("all", "none", "one_of", "exact", "only"),
  reverse = FALSE,
  lifecycle = deprecated(),
  eventlog = deprecated()
)

## S3 method for class 'grouped_eventlog'
filter_lifecycle_presence(
  log,
  lifecycles,
  method = c("all", "none", "one_of", "exact", "only"),
  reverse = FALSE,
  lifecycle = deprecated(),
  eventlog = deprecated()
)

Arguments

log

eventlog: Object of class eventlog or derivatives (grouped_eventlog).

lifecycles

character vector: A vector of life cycle 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.

lifecycle

[Deprecated]; please use lifecycles instead.

eventlog

[Deprecated]; please use log instead.

Details

This function allows to filter activity instances that (do not) contain certain life cycle identifiers. It requires as input a vector containing one or more life cycle labels and it has a method argument with following options:

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)

References

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

See Also

lifecycle_id

Other filters: filter_activity(), filter_activity_frequency(), filter_activity_instance(), filter_activity_presence(), filter_case(), filter_case_condition(), filter_endpoints(), filter_endpoints_condition(), filter_flow_time(), filter_idle_time(), filter_infrequent_flows(), filter_lifecycle(), 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()


Filter Precedence Relations

Description

Filters cases based on the precedence relations between two sets of activities.

Usage

filter_precedence(
  log,
  antecedents,
  consequents,
  precedence_type = c("directly_follows", "eventually_follows"),
  filter_method = c("all", "one_of", "none"),
  reverse = FALSE,
  eventlog = deprecated()
)

## S3 method for class 'log'
filter_precedence(
  log,
  antecedents,
  consequents,
  precedence_type = c("directly_follows", "eventually_follows"),
  filter_method = c("all", "one_of", "none"),
  reverse = FALSE,
  eventlog = deprecated()
)

## S3 method for class 'grouped_log'
filter_precedence(
  log,
  antecedents,
  consequents,
  precedence_type = c("directly_follows", "eventually_follows"),
  filter_method = c("all", "one_of", "none"),
  reverse = FALSE,
  eventlog = deprecated()
)

Arguments

log

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

antecedents, consequents

character vector: The set of antecendent and consequent activities. Both are character vectors containing at least one activity identifier. All pairs of antecedents and consequents are turned into seperate precedence rules.

precedence_type

character (default "directly_follows"): When "directly_follows", the consequent activity should happen immediately after the antecedent activities.
When "eventually_follows", other events are allowed to happen in between.

filter_method

character (default "all"): When "all", only cases where all the relations are valid are preserved.
When "one_of", all the cases where at least one of the conditions hold, are preserved.
When "none", none of the relations are allowed.

reverse

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

eventlog

[Deprecated]; please use log instead.

Details

In order to extract a subset of an event log which conforms with a set of precedence rules, one can use the filter_precedence method. There are two types of precendence relations which can be tested: activities that should directly follow ("directly_follows") each other, or activities that should eventually follow ("eventually_follows") each other. The type can be set with the precedence_type argument.

Further, the filter requires a vector of one or more antecedents (containing activity labels), and one or more consequents.

Finally, a filter_method argument can be set. This argument is relevant when there is more than one antecedent or consequent. In such a case, you can specify that all possible precedence combinations must be present ("all"), at least one of them ("one_of"), or none ("none").

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)

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_activity_presence(), 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_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()

Examples


eventdataR::patients %>%
	filter_precedence(antecedents = "Triage and Assessment",
					  consequents = "Blood test",
					  precedence_type = "directly_follows") %>%
	bupaR::traces()

eventdataR::patients %>%
	filter_precedence(antecedents = "Triage and Assessment",
					  consequents = c("Blood test", "X-Ray", "MRI SCAN"),
					  precedence_type = "eventually_follows",
					  filter_method = "one_of") %>%
	bupaR::traces()


Filter Precedence Relations

Description

Filters cases based on the precedence relations between two sets of activities. For more information, see filter_precedence.

Usage

filter_precedence_condition(
  log,
  antecedent_condition,
  consequent_condition,
  precedence_type = c("directly_follows", "eventually_follows"),
  reverse = FALSE,
  eventlog = deprecated()
)

## S3 method for class 'log'
filter_precedence_condition(
  log,
  antecedent_condition,
  consequent_condition,
  precedence_type = c("directly_follows", "eventually_follows"),
  reverse = FALSE,
  eventlog = deprecated()
)

## S3 method for class 'grouped_log'
filter_precedence_condition(
  log,
  antecedent_condition,
  consequent_condition,
  precedence_type = c("directly_follows", "eventually_follows"),
  reverse = FALSE,
  eventlog = deprecated()
)

Arguments

log

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

antecedent_condition, consequent_condition

The antecendent and consequent conditions.

precedence_type

character (default "directly_follows"): When "directly_follows", the consequent activity should happen immediately after the antecedent activities.
When "eventually_follows", other events are allowed to happen in between.

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.

Methods (by class)

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_activity_presence(), 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_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()


Filter Precedence Relations with Identical Resources

Description

Filters cases based on the precedence relations between two sets of activities, where both antecendent and consequent have to be executed by the same resource.

Usage

filter_precedence_resource(
  log,
  antecedents,
  consequents,
  precedence_type = c("directly_follows", "eventually_follows"),
  filter_method = c("all", "one_of", "none"),
  reverse = FALSE,
  eventlog = deprecated()
)

## S3 method for class 'eventlog'
filter_precedence_resource(
  log,
  antecedents,
  consequents,
  precedence_type = c("directly_follows", "eventually_follows"),
  filter_method = c("all", "one_of", "none"),
  reverse = FALSE,
  eventlog = deprecated()
)

## S3 method for class 'activitylog'
filter_precedence_resource(
  log,
  antecedents,
  consequents,
  precedence_type = c("directly_follows", "eventually_follows"),
  filter_method = c("all", "one_of", "none"),
  reverse = FALSE,
  eventlog = deprecated()
)

## S3 method for class 'grouped_log'
filter_precedence_resource(
  log,
  antecedents,
  consequents,
  precedence_type = c("directly_follows", "eventually_follows"),
  filter_method = c("all", "one_of", "none"),
  reverse = FALSE,
  eventlog = deprecated()
)

Arguments

log

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

antecedents, consequents

character vector: The set of antecendent and consequent activities. Both are character vectors containing at least one activity identifier. All pairs of antecedents and consequents are turned into seperate precedence rules.

precedence_type

character (default "directly_follows"): When "directly_follows", the consequent activity should happen immediately after the antecedent activities.
When "eventually_follows", other events are allowed to happen in between.

filter_method

character (default "all"): When "all", only cases where all the relations are valid are preserved.
When "one_of", all the cases where at least one of the conditions hold, are preserved.
When "none", none of the relations are allowed.

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.

Methods (by class)

References

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

See Also

filter_precedence()

Other filters: filter_activity(), filter_activity_frequency(), filter_activity_instance(), filter_activity_presence(), 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_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()


Filter Processing Time

Description

Filters cases based on their processing_time.

This filter can be used by using an interval or by using a percentage. The percentage will always start with the shortest cases 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 a processing time in this interval. The time units in which this interval is defined can be supplied with the units argument.

Usage

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

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

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

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().

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.

Methods (by class)

References

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

See Also

processing_time(),difftime()

Other filters: filter_activity(), filter_activity_frequency(), filter_activity_instance(), filter_activity_presence(), 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_resource(), filter_resource_frequency(), filter_throughput_time(), filter_time_period(), filter_trace(), filter_trace_frequency(), filter_trace_length(), filter_trim(), filter_trim_lifecycle()


Filter Resource

Description

Filters the log based on resource identifiers

This method can be used to filter on resource identifiers. It has a resources argument, to which a vector of identifiers can be given. The selection can be negated with the reverse argument.

Usage

filter_resource(log, resources, reverse = FALSE, eventlog = deprecated())

## S3 method for class 'log'
filter_resource(log, resources, reverse = FALSE, eventlog = deprecated())

## S3 method for class 'grouped_log'
filter_resource(log, resources, reverse = FALSE, eventlog = deprecated())

Arguments

log

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

resources

character vector: A vector of resources identifiers.

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.

Methods (by class)

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_activity_presence(), 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_frequency(), filter_throughput_time(), filter_time_period(), filter_trace(), filter_trace_frequency(), filter_trace_length(), filter_trim(), filter_trim_lifecycle()


Filter Resource Frequency

Description

Filters the log based on frequency of resources

Usage

filter_resource_frequency(
  log,
  interval = NULL,
  percentage = NULL,
  reverse = FALSE,
  eventlog = deprecated()
)

## S3 method for class 'log'
filter_resource_frequency(
  log,
  interval = NULL,
  percentage = NULL,
  reverse = FALSE,
  eventlog = deprecated()
)

## S3 method for class 'grouped_log'
filter_resource_frequency(
  log,
  interval = NULL,
  percentage = NULL,
  reverse = FALSE,
  eventlog = deprecated()
)

Arguments

log

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

percentage, interval

The target coverage of activity instances. Provide either percentage or interval.
percentage (numeric): A percentile of p will return the most common resource types of the log, which account for at least p% of the activity instances.
interval (numeric vector of length 2): A resource frequency interval. Half open interval can be created using NA.
For more information, see 'Details' below.

reverse

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

eventlog

[Deprecated]; please use log instead.

Details

Filtering the log based on resource frequency can be done in two ways: using an interval of allowed frequencies, or specify a coverage percentage:

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)

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_activity_presence(), 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_throughput_time(), filter_time_period(), filter_trace(), filter_trace_frequency(), filter_trace_length(), filter_trim(), filter_trim_lifecycle()


Filter Throughput Time

Description

Filters cases based on their throughput_time.

This filter can be used by using an interval or by using a percentage. The percentage will always start with the shortest cases 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 a throughput time in this interval. The time units in which this interval is defined can be supplied with the units argument.

Usage

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

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

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

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().

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.

Methods (by class)

References

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

See Also

throughput_time(),difftime()

Other filters: filter_activity(), filter_activity_frequency(), filter_activity_instance(), filter_activity_presence(), 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_time_period(), filter_trace(), filter_trace_frequency(), filter_trace_length(), filter_trim(), filter_trim_lifecycle()


Filter Time Period

Description

Function to filter the log using a time period.

Usage

filter_time_period(
  log,
  interval = NULL,
  filter_method = c("contained", "intersecting", "start", "complete", "trim"),
  force_trim = FALSE,
  reverse = FALSE,
  eventlog = deprecated()
)

## S3 method for class 'eventlog'
filter_time_period(
  log,
  interval = NULL,
  filter_method = c("contained", "intersecting", "start", "complete", "trim"),
  force_trim = FALSE,
  reverse = FALSE,
  eventlog = deprecated()
)

## S3 method for class 'grouped_eventlog'
filter_time_period(
  log,
  interval = NULL,
  filter_method = c("contained", "intersecting", "start", "complete", "trim"),
  force_trim = FALSE,
  reverse = FALSE,
  eventlog = deprecated()
)

## S3 method for class 'activitylog'
filter_time_period(
  log,
  interval = NULL,
  filter_method = c("contained", "intersecting", "start", "complete", "trim"),
  force_trim = FALSE,
  reverse = FALSE,
  eventlog = deprecated()
)

## S3 method for class 'grouped_activitylog'
filter_time_period(
  log,
  interval = NULL,
  filter_method = c("contained", "intersecting", "start", "complete", "trim"),
  force_trim = FALSE,
  reverse = FALSE,
  eventlog = deprecated()
)

Arguments

log

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

interval

Date or POSIXct vector: A time interval (vector of length 2 of type Date or POSIXct). Half-open intervals can be created with NA.

filter_method

character (default "contained"): Filtering method: "contained" (default), "intersecting", "start", "complete", or "trim". For more information, see 'Details' below.

force_trim

logical (default FALSE): If TRUE in combination with filter_method "trim", activity instances on the edges of the interval are cut at the exact edge of the interval.

reverse

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

eventlog

[Deprecated]; please use log instead.

Details

Event data can be filtered by supplying a time window to the method filter_time_period. There are 5 different values for filter_method:

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)

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_activity_presence(), 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_trace(), filter_trace_frequency(), filter_trace_length(), filter_trim(), filter_trim_lifecycle()


Filter Trace

Description

Filters the log based on trace identifier.

This method can be used to filter on trace identifier, which can be obtained from case_list. It has a trace_ids argument, to which a vector of identifiers can be given. The selection can be negated with the reverse argument.

Usage

filter_trace(log, trace_ids, reverse = FALSE, eventlog = deprecated())

## S3 method for class 'log'
filter_trace(log, trace_ids, reverse = FALSE, eventlog = deprecated())

## S3 method for class 'grouped_log'
filter_trace(log, trace_ids, reverse = FALSE, eventlog = deprecated())

Arguments

log

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

trace_ids

character vector: A vector of trace identifiers

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.

Methods (by class)

References

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

See Also

case_list

Other filters: filter_activity(), filter_activity_frequency(), filter_activity_instance(), filter_activity_presence(), 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_frequency(), filter_trace_length(), filter_trim(), filter_trim_lifecycle()


Filter Trace Frequency

Description

Filters the log based the frequency of traces, using an interval or a percentile cut off.

Usage

filter_trace_frequency(
  log,
  interval = NULL,
  percentage = NULL,
  reverse = FALSE,
  eventlog = deprecated()
)

## S3 method for class 'log'
filter_trace_frequency(
  log,
  interval = NULL,
  percentage = NULL,
  reverse = FALSE,
  eventlog = deprecated()
)

## S3 method for class 'grouped_log'
filter_trace_frequency(
  log,
  interval = NULL,
  percentage = NULL,
  reverse = FALSE,
  eventlog = deprecated()
)

Arguments

log

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

percentage, interval

The target coverage of activity instances. Provide either percentage or interval.
percentage (numeric): A percentile of p will select the most common traces of the log, until at least p% of the cases is covered.
interval (numeric vector of length 2): A trace frequency interval. The filter will select cases of which the trace has a frequency inside the interval. Half open interval can be created using NA.
For more information, see 'Details' below.

reverse

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

eventlog

[Deprecated]; please use log instead.

Details

Filtering the log based on trace frequency can be done in two ways: using an interval of allowed frequencies, or specify a coverage percentage:

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)

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_activity_presence(), 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_length(), filter_trim(), filter_trim_lifecycle()


Filter Trace Length

Description

Filters cases on trace_length, using a percentile threshold or interval.

This filter can be used by using an interval or by using a percentage. The percentage will always start with the shortest cases 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 a length in this interval.

Usage

filter_trace_length(
  log,
  interval = NULL,
  percentage = NULL,
  reverse = FALSE,
  eventlog = deprecated()
)

## S3 method for class 'log'
filter_trace_length(
  log,
  interval = NULL,
  percentage = NULL,
  reverse = FALSE,
  eventlog = deprecated()
)

## S3 method for class 'grouped_log'
filter_trace_length(
  log,
  interval = NULL,
  percentage = NULL,
  reverse = FALSE,
  eventlog = deprecated()
)

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 trace length interval. Half open interval can be created using NA.
percentage (numeric): A percentage p to be used for relative filtering.

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.

Methods (by class)

References

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

See Also

trace_length

Other filters: filter_activity(), filter_activity_frequency(), filter_activity_instance(), filter_activity_presence(), 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_trim(), filter_trim_lifecycle()


Trim Cases

Description

Trim cases from the first event of a set of start activities to the last event of a set of end activities.

One can trim cases by removing one or more activity instances at the start and/or end of a case. Trimming is performed until all cases have a start and/or end point belonging to a set of allowed activity labels. This filter requires a set of allowed start activities and/or a set of allowed end activities. If one of them is not provided it will not trim the cases at this edge. The selection can be reversed, which means that only the trimmed events at the start and end of cases are retained. As such, this argument allows to cut intermediate parts out of traces.

Usage

filter_trim(
  log,
  start_activities = NULL,
  end_activities = NULL,
  reverse = FALSE,
  eventlog = deprecated()
)

## S3 method for class 'eventlog'
filter_trim(
  log,
  start_activities = NULL,
  end_activities = NULL,
  reverse = FALSE,
  eventlog = deprecated()
)

## S3 method for class 'grouped_eventlog'
filter_trim(
  log,
  start_activities = NULL,
  end_activities = NULL,
  reverse = FALSE,
  eventlog = deprecated()
)

## S3 method for class 'activitylog'
filter_trim(
  log,
  start_activities = NULL,
  end_activities = NULL,
  reverse = FALSE,
  eventlog = deprecated()
)

## S3 method for class 'grouped_activitylog'
filter_trim(
  log,
  start_activities = NULL,
  end_activities = NULL,
  reverse = FALSE,
  eventlog = deprecated()
)

Arguments

log

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

start_activities, end_activities

character vector (default NULL): A vector of activity identifiers, or NULL.

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.

Methods (by class)

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_activity_presence(), 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_lifecycle()


Filter Trim Life Cycle

Description

Trim activity instances from the first event of a set of start life cycle labels to the last event of a set of end life cycle labels.

One can trim activity instances by removing one or more events at the start and/or end of the activity instances. Trimming is performed until all activity instances have a start and/or end point belonging to a set of allowed life cycle labels. This filter requires a set of allowed start life cycle labels and/or a set of allowed life cycle labels. If one of them is not provided it will not trim the activity instances at this edge.The selection can be reversed, which means that only the trimmed events at the start and end of activity instances are retained. As such, this argument allows to cut intermediate parts out of activity instances.

Usage

filter_trim_lifecycle(
  log,
  start_lifecycles = NULL,
  end_lifecycles = NULL,
  reverse = FALSE,
  start_lifecycle = deprecated(),
  end_lifecycle = deprecated(),
  eventlog = deprecated()
)

## S3 method for class 'eventlog'
filter_trim_lifecycle(
  log,
  start_lifecycles = NULL,
  end_lifecycles = NULL,
  reverse = FALSE,
  start_lifecycle = deprecated(),
  end_lifecycle = deprecated(),
  eventlog = deprecated()
)

## S3 method for class 'grouped_eventlog'
filter_trim_lifecycle(
  log,
  start_lifecycles = NULL,
  end_lifecycles = NULL,
  reverse = FALSE,
  start_lifecycle = deprecated(),
  end_lifecycle = deprecated(),
  eventlog = deprecated()
)

Arguments

log

eventlog: Object of class eventlog or derivatives (grouped_eventlog).

start_lifecycles, end_lifecycles

character vector (default NULL): A vector of life cycle identifiers, or NULL.

reverse

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

start_lifecycle

[Deprecated]; please use start_lifecycles instead.

end_lifecycle

[Deprecated]; please use end_lifecycles instead.

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.

Methods (by class)

References

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

See Also

lifecycle_id

Other filters: filter_activity(), filter_activity_frequency(), filter_activity_instance(), filter_activity_presence(), 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()


Idle Time

Description

Calculates the amount of time that no activity occurs.

Usage

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

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

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

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

## S3 method for class 'grouped_activitylog'
idle_time(
  log,
  level = c("log", "trace", "case", "resource", "flow"),
  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:

Methods (by class)

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()


ifilter functions

Description

ifilter functions

Usage

ifilter_activity(eventlog)

ifilter_activity_frequency(eventlog)

ifilter_activity_instance(eventlog)

ifilter_activity_presence(eventlog)

ifilter_case(eventlog)

ifilter_endpoints(eventlog)

ifilter_lifecycle(eventlog)

ifilter_lifecycle_presence(eventlog)

ifilter_precedence(eventlog)

ifilter_processing_time(eventlog)

ifilter_resource(eventlog)

ifilter_resource_frequency(eventlog)

ifilter_throughput_time(eventlog)

ifilter_time_period(eventlog)

ifilter_trace_frequency(eventlog)

ifilter_trace_length(eventlog)

ifilter_trim(eventlog)

ifilter_trim_lifecycle(eventlog)

Number of Repetitions

Description

Provides information statistics on the number of repetitions

A repetition is an execution of an activity within a case while that activity has already been executed before, but one or more other activities are executed in between.

Usage

number_of_repetitions(
  log,
  type = c("all", "repeat", "redo"),
  level = c("log", "case", "activity", "resource", "resource-activity"),
  append = deprecated(),
  append_column = NULL,
  sort = TRUE,
  eventlog = deprecated()
)

## S3 method for class 'eventlog'
number_of_repetitions(
  log,
  type = c("all", "repeat", "redo"),
  level = c("log", "case", "activity", "resource", "resource-activity"),
  append = deprecated(),
  append_column = NULL,
  sort = TRUE,
  eventlog = deprecated()
)

## S3 method for class 'grouped_eventlog'
number_of_repetitions(
  log,
  type = c("all", "repeat", "redo"),
  level = c("log", "case", "activity", "resource", "resource-activity"),
  append = deprecated(),
  append_column = NULL,
  sort = TRUE,
  eventlog = deprecated()
)

## S3 method for class 'activitylog'
number_of_repetitions(
  log,
  type = c("all", "repeat", "redo"),
  level = c("log", "case", "activity", "resource", "resource-activity"),
  append = deprecated(),
  append_column = NULL,
  sort = TRUE,
  eventlog = deprecated()
)

## S3 method for class 'grouped_activitylog'
number_of_repetitions(
  log,
  type = c("all", "repeat", "redo"),
  level = c("log", "case", "activity", "resource", "resource-activity"),
  append = deprecated(),
  append_column = NULL,
  sort = TRUE,
  eventlog = deprecated()
)

Arguments

log

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

type

character (default "all"): The type of repetitions: "all" (default), "repeat", or "redo". For more information, see 'Details' below.

level

character (default "log"): Level of granularity for the analysis: "log" (default), "case", "activity", "resource", or "resource-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:

Similar to the self-loop metric, a distinction should be made between "repeat" and "redo" repetitions, as can be set by the type argument:

Methods (by class)

References

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

See Also

number_of_selfloops

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


Number of Self-loops

Description

Provides information statistics on the number of self-loops in a trace.

Activity instances of the same activity type that are executed more than once immediately after each other by the same resource are in a self-loop ("length-1-loop"). If an activity instance of the same activity type is executed 3 times after each other by the same resource, this is defined as a "size 2 self-loop".

Usage

number_of_selfloops(
  log,
  type = c("all", "repeat", "redo"),
  level = c("log", "case", "activity", "resource", "resource-activity"),
  append = deprecated(),
  append_column = NULL,
  sort = TRUE,
  eventlog = deprecated()
)

## S3 method for class 'eventlog'
number_of_selfloops(
  log,
  type = c("all", "repeat", "redo"),
  level = c("log", "case", "activity", "resource", "resource-activity"),
  append = deprecated(),
  append_column = NULL,
  sort = TRUE,
  eventlog = deprecated()
)

## S3 method for class 'grouped_eventlog'
number_of_selfloops(
  log,
  type = c("all", "repeat", "redo"),
  level = c("log", "case", "activity", "resource", "resource-activity"),
  append = deprecated(),
  append_column = NULL,
  sort = TRUE,
  eventlog = deprecated()
)

## S3 method for class 'activitylog'
number_of_selfloops(
  log,
  type = c("all", "repeat", "redo"),
  level = c("log", "case", "activity", "resource", "resource-activity"),
  append = deprecated(),
  append_column = NULL,
  sort = TRUE,
  eventlog = deprecated()
)

## S3 method for class 'grouped_activitylog'
number_of_selfloops(
  log,
  type = c("all", "repeat", "redo"),
  level = c("log", "case", "activity", "resource", "resource-activity"),
  append = deprecated(),
  append_column = NULL,
  sort = TRUE,
  eventlog = deprecated()
)

Arguments

log

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

type

character (default "all"): The type of repetitions: "all" (default), "repeat", or "redo". For more information, see 'Details' below.

level

character (default "log"): Level of granularity for the analysis: "log" (default), "case", "activity", "resource", or "resource-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

Two types of self-loops are defined, which can be chosen using the type argument:

Argument level has the following options:

Methods (by class)

References

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

See Also

number_of_repetitions

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


Number of Traces

Description

Computes how many traces there are.

This metric provides two values, the absolute and relative number of traces that occur in the log. The relative number shows expected number of traces needed to cover 100 cases.

Usage

number_of_traces(log, eventlog = deprecated())

## S3 method for class 'log'
number_of_traces(log, eventlog = deprecated())

## S3 method for class 'grouped_log'
number_of_traces(log, eventlog = deprecated())

Arguments

log

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

eventlog

[Deprecated]; please use log instead.

Methods (by class)

References

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

See Also

traces

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


Plot Methods

Description

Visualize metric

Usage

## S3 method for class 'activity_frequency'
plot(x, ...)

## S3 method for class 'activity_presence'
plot(x, ...)

## S3 method for class 'end_activities'
plot(x, ...)

## S3 method for class 'idle_time'
plot(x, ...)

## S3 method for class 'processing_time'
plot(x, ...)

## S3 method for class 'referral_matrix'
plot(x, ...)

## S3 method for class 'resource_frequency'
plot(x, ...)

## S3 method for class 'resource_involvement'
plot(x, ...)

## S3 method for class 'resource_specialisation'
plot(x, ...)

## S3 method for class 'start_activities'
plot(x, ...)

## S3 method for class 'throughput_time'
plot(x, ...)

## S3 method for class 'trace_coverage'
plot(x, ...)

## S3 method for class 'trace_length'
plot(x, ...)

## S3 method for class 'number_of_selfloops'
plot(x, ...)

## S3 method for class 'number_of_repetitions'
plot(x, ...)

Arguments

x

Data to plot

...

Additional variables

Value

A ggplot object, which can be customized further, if deemed necessary.


Print work schedule

Description

Print work schedule

Usage

## S3 method for class 'work_schedule'
print(x, ...)

Arguments

x

Work schedule to print

...

Additional arguments (ignored)


Processing Time

Description

Provides summary statistics about the processing time of the process.

In contrast to the throughput_time() of the cases in a log, the metrics concerning the active time or the actual processing time provide summary statistics on the processing time of events on the level of the complete log, the specific cases, traces, the activities, and the resource-activity combinations.

Usage

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

## S3 method for class 'eventlog'
processing_time(
  log,
  level = c("log", "trace", "case", "activity", "resource", "resource-activity",
    "activity-instance"),
  append = deprecated(),
  append_column = NULL,
  units = c("auto", "secs", "mins", "hours", "days", "weeks"),
  sort = TRUE,
  work_schedule = NULL,
  eventlog = deprecated()
)

## S3 method for class 'grouped_eventlog'
processing_time(
  log,
  level = c("log", "trace", "case", "activity", "resource", "resource-activity",
    "activity-instance"),
  append = deprecated(),
  append_column = NULL,
  units = c("auto", "secs", "mins", "hours", "days", "weeks"),
  sort = TRUE,
  work_schedule = NULL,
  eventlog = deprecated()
)

## S3 method for class 'activitylog'
processing_time(
  log,
  level = c("log", "trace", "case", "activity", "resource", "resource-activity",
    "activity-instance"),
  append = deprecated(),
  append_column = NULL,
  units = c("auto", "secs", "mins", "hours", "days", "weeks"),
  sort = TRUE,
  work_schedule = NULL,
  eventlog = deprecated()
)

## S3 method for class 'grouped_activitylog'
processing_time(
  log,
  level = c("log", "trace", "case", "activity", "resource", "resource-activity",
    "activity-instance"),
  append = deprecated(),
  append_column = NULL,
  units = c("auto", "secs", "mins", "hours", "days", "weeks"),
  sort = TRUE,
  work_schedule = NULL,
  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", "activity", "resource", or "resource-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.

units

character (default "auto"): The time unit in which the processing 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 on decreasing processing time. For "case" level only.

work_schedule

A schedule of working hours. If provided, only working hours are counted as processing time.

eventlog

[Deprecated]; please use log instead.

Details

Argument level has the following options:

Methods (by class)

References

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

See Also

idle_time(),throughput_time(),difftime()

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


Referral matrix repetitons

Description

Provides a list of initatiors and completers of redo repetitons

Usage

redo_repetitions_referral_matrix(log, eventlog = deprecated())

## S3 method for class 'eventlog'
redo_repetitions_referral_matrix(log, eventlog = deprecated())

## S3 method for class 'activitylog'
redo_repetitions_referral_matrix(log, eventlog = deprecated())

Arguments

log

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

eventlog

[Deprecated]; please use log instead.

Methods (by class)

References

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

See Also

number_of_repetitions


Referral matrix selfloops

Description

Provides a list of initatiors and completers of redo selfloops

Usage

redo_selfloops_referral_matrix(log, eventlog = deprecated())

## S3 method for class 'eventlog'
redo_selfloops_referral_matrix(log, eventlog = deprecated())

## S3 method for class 'activitylog'
redo_selfloops_referral_matrix(log, eventlog = deprecated())

Arguments

log

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

eventlog

[Deprecated]; please use log instead.

Methods (by class)

References

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

See Also

number_of_selfloops


Objects exported from other packages

Description

These objects are imported from other packages. Follow the links below to see their documentation.

magrittr

%>%


Resource Frequency

Description

Analyses the frequency of resources at different levels of analysis.

Usage

resource_frequency(
  log,
  level = c("log", "case", "activity", "resource", "resource-activity"),
  append = deprecated(),
  append_column = NULL,
  sort = TRUE,
  eventlog = deprecated()
)

## S3 method for class 'eventlog'
resource_frequency(
  log,
  level = c("log", "case", "activity", "resource", "resource-activity"),
  append = deprecated(),
  append_column = NULL,
  sort = TRUE,
  eventlog = deprecated()
)

## S3 method for class 'grouped_eventlog'
resource_frequency(
  log,
  level = c("log", "case", "activity", "resource", "resource-activity"),
  append = deprecated(),
  append_column = NULL,
  sort = TRUE,
  eventlog = deprecated()
)

## S3 method for class 'activitylog'
resource_frequency(
  log,
  level = c("log", "case", "activity", "resource", "resource-activity"),
  append = deprecated(),
  append_column = NULL,
  sort = TRUE,
  eventlog = deprecated()
)

## S3 method for class 'grouped_activitylog'
resource_frequency(
  log,
  level = c("log", "case", "activity", "resource", "resource-activity"),
  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), "case", "activity", "resource", or "resource-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:

Methods (by class)

References

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

See Also

resource_involvement

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


Resource Involvement

Description

Calculates for each resource or resource-activity combination in what percentage of cases it is present.

Next to the resource_frequency, the involvement of resources in cases can be of interest to, e.g., decide how "indispensable" they are. This metric is provided on three levels of analysis, which are the cases, the resources, and the resource-activity combinations.

Usage

resource_involvement(
  log,
  level = c("case", "resource", "resource-activity"),
  append = deprecated(),
  append_column = NULL,
  sort = TRUE,
  eventlog = deprecated()
)

## S3 method for class 'log'
resource_involvement(
  log,
  level = c("case", "resource", "resource-activity"),
  append = deprecated(),
  append_column = NULL,
  sort = TRUE,
  eventlog = deprecated()
)

## S3 method for class 'grouped_log'
resource_involvement(
  log,
  level = c("case", "resource", "resource-activity"),
  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 "case"): Level of granularity for the analysis: "case" (default), "resource", or "resource-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:

Methods (by class)

References

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

See Also

resource_frequency

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


Resource Specialisation

Description

Analyses whether resources specialise in specific activities.

This metric can give an overview of which resources are performing certain activities more than others, and which resources are responsible for containing all knowledge or capabilities on one topic.

Usage

resource_specialisation(
  log,
  level = c("log", "activity", "resource"),
  append = deprecated(),
  append_column = NULL,
  sort = TRUE,
  eventlog = deprecated()
)

resource_specialization(
  log,
  level = c("log", "activity", "resource"),
  append = deprecated(),
  append_column = NULL,
  sort = TRUE,
  eventlog = deprecated()
)

## S3 method for class 'log'
resource_specialisation(
  log,
  level = c("log", "activity", "resource"),
  append = deprecated(),
  append_column = NULL,
  sort = TRUE,
  eventlog = deprecated()
)

## S3 method for class 'grouped_log'
resource_specialisation(
  log,
  level = c("log", "activity", "resource"),
  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), , "activity", 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.

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:

Methods (by class)

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(), start_activities(), throughput_time(), trace_coverage(), trace_length()


Set operations

Description

Set operations

Usage

setdiff(x, y, ...)

## S3 method for class 'eventlog'
setdiff(x, y, ...)

Arguments

x

Eventlog

y

Eventlog

...

Ignored

Value

Eventlog of activity instances in x which do not belong to y

Methods (by class)


Metric: Size of repetitions

Description

Provides summary statistics on the sizes of repetitions.

Usage

size_of_repetitions(
  log,
  type = c("all", "repeat", "redo"),
  level = c("log", "case", "activity", "resource", "resource-activity"),
  append = deprecated(),
  append_column = NULL,
  eventlog = deprecated()
)

## S3 method for class 'eventlog'
size_of_repetitions(
  log,
  type = c("all", "repeat", "redo"),
  level = c("log", "case", "activity", "resource", "resource-activity"),
  append = deprecated(),
  append_column = NULL,
  eventlog = deprecated()
)

## S3 method for class 'grouped_eventlog'
size_of_repetitions(
  log,
  type = c("repeat", "redo"),
  level = c("log", "case", "activity", "resource", "resource-activity"),
  append = deprecated(),
  append_column = NULL,
  eventlog = deprecated()
)

## S3 method for class 'activitylog'
size_of_repetitions(
  log,
  type = c("repeat", "redo"),
  level = c("log", "case", "activity", "resource", "resource-activity"),
  append = deprecated(),
  append_column = NULL,
  eventlog = deprecated()
)

## S3 method for class 'grouped_activitylog'
size_of_repetitions(
  log,
  type = c("repeat", "redo"),
  level = c("log", "case", "activity", "resource", "resource-activity"),
  append = deprecated(),
  append_column = NULL,
  eventlog = deprecated()
)

Arguments

log

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

type

character (default "all"): The type of repetitions: "all" (default), "repeat", or "redo". For more information, see 'Details' below.

level

character (default "log"): Level of granularity for the analysis: "log" (default), "case", "activity", "resource", or "resource-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.

eventlog

[Deprecated]; please use log instead.

Methods (by class)

References

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

See Also

number_of_repetitions


Metric: Size of selfloops

Description

Provides summary statistics on the sizes of selfloops

Usage

size_of_selfloops(
  log,
  type = c("all", "repeat", "redo"),
  level = c("log", "case", "activity", "resource", "resource-activity"),
  append = deprecated(),
  append_column = NULL,
  eventlog = deprecated()
)

## S3 method for class 'eventlog'
size_of_selfloops(
  log,
  type = c("all", "repeat", "redo"),
  level = c("log", "case", "activity", "resource", "resource-activity"),
  append = deprecated(),
  append_column = NULL,
  eventlog = deprecated()
)

## S3 method for class 'grouped_eventlog'
size_of_selfloops(
  log,
  type = c("repeat", "redo"),
  level = c("log", "case", "activity", "resource", "resource-acitivty"),
  append = deprecated(),
  append_column = NULL,
  eventlog = deprecated()
)

## S3 method for class 'activitylog'
size_of_selfloops(
  log,
  type = c("all", "repeat", "redo"),
  level = c("log", "case", "activity", "resource", "resource-activity"),
  append = deprecated(),
  append_column = NULL,
  eventlog = deprecated()
)

## S3 method for class 'grouped_activitylog'
size_of_selfloops(
  log,
  type = c("all", "repeat", "redo"),
  level = c("log", "case", "activity", "resource", "resource-activity"),
  append = deprecated(),
  append_column = NULL,
  eventlog = deprecated()
)

Arguments

log

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

type

character (default "all"): The type of repetitions: "all" (default), "repeat", or "redo". For more information, see 'Details' below.

level

character (default "log"): Level of granularity for the analysis: "log" (default), "case", "activity", "resource", or "resource-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.

eventlog

[Deprecated]; please use log instead.

Methods (by class)

References

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

See Also

number_of_selfloops


Start Activities

Description

Analyse the start activities in the process.

Usage

start_activities(
  log,
  level = c("log", "case", "activity", "resource", "resource-activity"),
  append = deprecated(),
  append_column = NULL,
  sort = TRUE,
  eventlog = deprecated()
)

## S3 method for class 'eventlog'
start_activities(
  log,
  level = c("log", "case", "activity", "resource", "resource-activity"),
  append = deprecated(),
  append_column = NULL,
  sort = TRUE,
  eventlog = deprecated()
)

## S3 method for class 'grouped_eventlog'
start_activities(
  log,
  level = c("log", "case", "activity", "resource", "resource-activity"),
  append = deprecated(),
  append_column = NULL,
  sort = TRUE,
  eventlog = deprecated()
)

## S3 method for class 'activitylog'
start_activities(
  log,
  level = c("log", "case", "activity", "resource", "resource-activity"),
  append = deprecated(),
  append_column = NULL,
  sort = TRUE,
  eventlog = deprecated()
)

## S3 method for class 'grouped_activitylog'
start_activities(
  log,
  level = c("log", "case", "activity", "resource", "resource-activity"),
  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), "case", "activity", "resource", or "resource-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:

Methods (by class)

References

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

See Also

end_activities

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(), throughput_time(), trace_coverage(), trace_length()


Throughput Time of Cases

Description

Provides summary statistics concerning the throughput times of cases.

Usage

throughput_time(
  log,
  level = c("log", "trace", "case", "activity", "activity-instance"),
  append = deprecated(),
  append_column = NULL,
  units = c("auto", "secs", "mins", "hours", "days", "weeks"),
  sort = TRUE,
  work_schedule = NULL,
  eventlog = deprecated()
)

## S3 method for class 'eventlog'
throughput_time(
  log,
  level = c("log", "trace", "case", "activity", "activity-instance"),
  append = deprecated(),
  append_column = NULL,
  units = c("auto", "secs", "mins", "hours", "days", "weeks"),
  sort = TRUE,
  work_schedule = NULL,
  eventlog = deprecated()
)

## S3 method for class 'grouped_eventlog'
throughput_time(
  log,
  level = c("log", "trace", "case", "activity", "activity-instance"),
  append = deprecated(),
  append_column = NULL,
  units = c("auto", "secs", "mins", "hours", "days", "weeks"),
  sort = TRUE,
  work_schedule = NULL,
  eventlog = deprecated()
)

## S3 method for class 'activitylog'
throughput_time(
  log,
  level = c("log", "trace", "case", "activity", "activity-instance"),
  append = deprecated(),
  append_column = NULL,
  units = c("auto", "secs", "mins", "hours", "days", "weeks"),
  sort = TRUE,
  work_schedule = NULL,
  eventlog = deprecated()
)

## S3 method for class 'grouped_activitylog'
throughput_time(
  log,
  level = c("log", "trace", "case", "activity", "activity-instance"),
  append = deprecated(),
  append_column = NULL,
  units = c("auto", "secs", "mins", "hours", "days", "weeks"),
  sort = TRUE,
  work_schedule = NULL,
  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.

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 output on count. Only for levels with frequency count output.

work_schedule

A schedule of working hours. If provided, only working hours are counted as processing time.

eventlog

[Deprecated]; please use log instead.

Details

Argument level has the following options:

Methods (by class)

References

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

See Also

idle_time(),processing_time(),difftime()

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(), trace_coverage(), trace_length()


Trace Coverage

Description

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:

Methods (by class)

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()


Trace Length

Description

Analysis of trace lengths

This metric provides an overview of the number of activities that occur in each trace.

An important remark is that this metric takes into account each instance of an activity, but not the individual lifecycle events.

Usage

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

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

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

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

## S3 method for class 'grouped_activitylog'
trace_length(
  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:

Methods (by class)

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_coverage()