R: Filter Time Period

filter_time_period {edeaR}

R Documentation

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`	; 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:

"contained": Keeps all the events related to cases contained in the time period.
"intersecting": Keeps all the events related to cases in which at least one event started and/or ended in the time period.
"start": Keeps all the events related to cases started in the time period.
"complete": Keeps all the events related to cases complete in the time period.
"trim": Keeps all the events which started and ended in the time frame.

Value

When given an object of type log, it will return a filtered log. When given an object of type grouped_log, the filter will be applied in a stratified way (i.e. each separately for each group). The returned log will be grouped on the same variables as the original log.

Methods (by class)

filter_time_period(eventlog): Filters activity instances for an eventlog.
filter_time_period(grouped_eventlog): Filters activity instances for a grouped_eventlog.
filter_time_period(activitylog): Filters activity instances for an activitylog.
filter_time_period(grouped_activitylog): Filters activity instances for a grouped_activitylog.

References

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