Standardize a relational event log

Module A focuses on preprocessing utilities. This helper normalizes user supplied event logs into the canonical sender/receiver/time structure expected elsewhere in the package. It also handles common cleaning tasks such as sorting, dropping missing rows, and removing loops.

Usage

standardize_event_log(
  event_log,
  sender_col = "sender",
  receiver_col = "receiver",
  time_col = "time",
  sort = TRUE,
  drop_nas = TRUE,
  drop_loops = FALSE,
  strictly_increasing_time = FALSE,
  remove_duplicates = TRUE,
  keep_extra = TRUE
)

Arguments

event_log

A data.frame (or tibble) containing at least one row per event.

sender_col, receiver_col, time_col

Column names storing the sender, receiver, and time information.

sort

Logical; should the output be sorted by time (ties are kept in input order)?

drop_nas

Logical; if TRUE, rows with missing sender/receiver/time are removed. Otherwise an error is thrown when NAs are present.

drop_loops

Logical; when TRUE, self-loops (sender == receiver) are dropped.

strictly_increasing_time

Logical; if TRUE, an error is raised when non-increasing time stamps are detected after sorting.

remove_duplicates

Logical; drop duplicated combinations of sender/receiver/time.

keep_extra

Logical; if FALSE, only the standardized columns are returned. When TRUE, additional columns from the original input are preserved.

Value

A data.frame with columns sender, receiver, and time. The return object is tagged with class "amorem_event_log" for downstream dispatch.

Examples

data(classroom_events)
std <- standardize_event_log(classroom_events)
head(std)
#>    time sender receiver interaction_type weight
#> 1 0.125     14       12           social      1
#> 2 0.250     12       14           social      1
#> 3 0.375     18       12         sanction      1
#> 4 0.500     12       18         sanction      1
#> 5 0.625      1       12         sanction      1
#> 6 0.750     12        1         sanction      1