filter_time_period: Filter: Time Period

In gertjanssenswillen/edeaR: Exploratory and Descriptive Event-Based Data Analysis

Description

Function to filter eventlog using a time period.

Usage

filter_time_period(eventlog, interval, filter_method, force_trim, reverse,
  ...)

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

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

ifilter_time_period(eventlog)

Arguments

eventlog	The dataset to be used. Should be a (grouped) eventlog object.
interval	A time interval. A vector of length 2 of type Date or POSIXct. Half-open intervals can be created with NA.
filter_method	Can be contained, start, complete, intersecting or trim.
force_trim	Logical, 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, indicating whether the selection should be reversed.
...	Deprecated arguments.

Details

Event data can be filtered by supplying a time window to the method filter_time_period. There are 5 different filter methods.

• contained keeps all the events related to cases contained 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.

• intersecting keeps all the events related to cases in which at least one event started and/or ended in the time period.

• trim keeps all the events which started and ended in the time frame.

Value

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

Methods (by class)

• eventlog: Filter event log

• grouped_eventlog: Filter grouped event log

See Also

vignette("filters", "edeaR")

gertjanssenswillen/edeaR documentation built on July 22, 2019, 7:08 p.m.