R/simple_eventlog.R

In bupaR: Business Process Analysis in R

#' @title Simple Eventlog
#'
#' @description
#' `r lifecycle::badge("superseded")`
#'
#' A function to instantiate an object of class \code{eventlog} by specifying a
#' \code{data.frame} or \code{tibble} and the minimally required case identifier, activity identifier and timestamp.
#'
#' This function is superseded by the introduction of the activitylog format.
#' Eventlogs in this 'simple' format can be seen as log of activities, and be created with `activitylog()`. If required, the resulting activity log can be transformed back to the eventlog format using `to_eventlog`.
#'
#'
#' @param eventlog The data object to be used as event log. This can be a
#' \code{data.frame} or \code{tibble}.
#' @param case_id The case classifier of the event log.
#' @param activity_id The activity classifier of the event log.
#' @param timestamp The timestamp of the event log.
#' @param resource_id The resource classifier of the event log (optional).
#' @param order Configure how to handle sort events with equal timestamps:
#' auto will use the order in the original data,
#' alphabetical will sort the activity labels by alphabet,
#' sorted will assume that the data frame is already correctly sorted and has a column '.order',
#' providing a column name will use this column for ordering (can be numeric of character).
#' The latter will never overrule timestamp orderings.
#'
#' @param return_type Whether to return eventlog (default) or activitylog object.
#'
#' @seealso \code{\link{eventlog}},\code{\link{case_id}}, \code{\link{activity_id}},
#' \code{\link{activity_instance_id}},\code{\link{lifecycle_id}},
#'  \code{\link{timestamp}}
#'
#' @examples
#' \dontrun{
#' data <- data.frame(case = rep("A",5),
#' activity_id = c("A","B","C","D","E"),
#' timestamp = date_decimal(1:5))
#' simple_eventlog(data,case_id = "case",
#' activity_id = "activity_id",
#' timestamp = "timestamp")
#'}
#' @export simple_eventlog


simple_eventlog <- function(eventlog,
							case_id = NULL,
							activity_id = NULL,
							timestamp = NULL,
							resource_id = NULL,
							order = "auto",
							return_type = c("eventlog","activitylog")) {

	deprecate_warn("5.0.0", "simple_eventlog()", "activitylog()")


	return_type <- match.arg(return_type)

	if(is.null(resource_id)) {
		eventlog %>%
			mutate(resource_id = "undefined") -> eventlog
		resource_id <- "resource_id"
	}

	if(return_type == "eventlog") {
		eventlog <- eventlog %>%
			mutate(activity_instance_id = 1:nrow(.),
				   lifecycle_id = "undefined")

		eventlog(eventlog,
				 case_id,
				 activity_id,
				 activity_instance_id = "activity_instance_id",
				 lifecycle_id = "lifecycle_id",
				 timestamp,
				 resource_id,
				 order = order,
				 validate = FALSE)

	} else if(return_type == "activitylog") {
		activitylog(activitylog = eventlog,
					case_id = case_id,
					activity_id = activity_id,
					resource_id = resource_id,
					timestamps = timestamp)
	}



}
#' @rdname simple_eventlog
#' @export isimple_eventlog
isimple_eventlog <- function(eventlog){

	ui <- miniPage(
		gadgetTitleBar("Create eventlog"),
		miniContentPanel(
			fillRow(fillCol(
				selectizeInput("case_id", "Case identifier", choices = c("",colnames(eventlog)),
							   selected = ifelse(is.null(attr(eventlog, "case_id")), NA, attr(eventlog, "case_id"))),
				selectizeInput("activity_id", "Activity identifier", choices = c("",colnames(eventlog)),
							   selected = ifelse(is.null(attr(eventlog, "activity_id")), NA, attr(eventlog, "activity_id"))),
				selectizeInput("timestamp", "Timestamp", choices =  c("",colnames(eventlog)),
							   selected = ifelse(is.null(attr(eventlog, "timestamp")), NA, attr(eventlog, "timestamp"))),
				selectizeInput("resource_id", "Resource identifier", choices =  c("",colnames(eventlog)),
							   selected = ifelse(is.null(attr(eventlog, "resource_id")), NA, attr(eventlog, "resource_id")))

			)

			))
	)

	server <- function(input, output, session){
		observeEvent(input$done, {
			stopApp(simple_eventlog(eventlog = eventlog,
									case_id = input$case_id,
									activity_id = input$activity_id,
									timestamp = input$timestamp))
		})


	}

	runGadget(ui, server, viewer = dialogViewer("Create simple event log", height = 400))

}