R/filter_endpoints.R

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

#' Filter: Start and end activities
#'
#' 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 event log accordingly.
#'
#'
#' @param start_activities A vector of activity identifiers, or NULL
#'
#' @param end_activities A vector of activity identifiers, or NULL
#'
#' @param percentage 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.
#'
#' @inherit filter_activity params references seealso return
#'
#' @export filter_endpoints

filter_endpoints <- function(eventlog,
							 start_activities,
							 end_activities,
							 percentage,
							 reverse,
							 ...) {
	UseMethod("filter_endpoints")
}

#' @describeIn filter_endpoints Filter event log
#' @export

filter_endpoints.eventlog <- function(eventlog,
							 start_activities = NULL,
							 end_activities = NULL,
							 percentage = NULL,
							 reverse = FALSE,
							 ...) {

	percentage <- deprecated_perc(percentage, ...)

	if(is.null(start_activities) & is.null(end_activities) & is.null(percentage))
		stop("At least one set of start or end activities or a percentage must be provided.")
	if((!is.null(start_activities) & !is.null(percentage)) | (!is.null(end_activities) & !is.null(percentage)))
		stop("Cannot filter on both sets of start and end activities and percentage simultaneously.")
	if(!is.null(percentage))
		return(filter_endpoints_percentile(eventlog,
										   percentage = percentage,
										   reverse = reverse ))
	else
		return(filter_endpoints_sets(eventlog,
									 start_activities = start_activities,
									 end_activities = end_activities,
									 reverse = reverse))
}
#' @describeIn filter_endpoints Filter grouped event log stratified
#' @export

filter_endpoints.grouped_eventlog <- function(eventlog,
											  start_activities = NULL,
											  end_activities = NULL,
											  percentage = NULL,
											  reverse = FALSE,
											  ...) {
	grouped_filter(eventlog, filter_endpoints, start_activities, end_activities, percentage, reverse, ...)
}




#' @rdname filter_endpoints
#' @export ifilter_endpoints
#'

ifilter_endpoints <- function(eventlog) {

	ui <- miniPage(
		gadgetTitleBar("Filter End Points"),
		miniContentPanel(
			fillCol(flex = c(3,8),
					fillRow(
						radioButtons("filter_type", "Filter type:", choices = c("Select from list" = "list", "Use percentile cutoff" = "percentile")),
						radioButtons("reverse", "Reverse filter: ", choices = c("Yes","No"), selected = "No")
					),
					uiOutput("filter_ui")
					)
		)
	)

	server <- function(input, output, session){

		output$filter_ui <- renderUI({
			if(input$filter_type == "list") {
				fillRow(flex = c(8,1,8),
					selectizeInput("start", label = "Select start activities:",
								   choices = eventlog %>%
								   	start_activities_activity %>%
								   	pull(!!as.symbol(activity_id(eventlog))) %>%
								   	unique, selected = NA,  multiple = TRUE), " ",
					selectizeInput("end", label = "Select end activities:",
								   choices = eventlog %>%
								   	end_activities_activity %>%
								   	pull(!!as.symbol(activity_id(eventlog))) %>%
								   	unique, selected = NA,  multiple = TRUE)
				) %>% return()
			}
			else if(input$filter_type == "percentile") {
				sliderInput("percentile_slider", "Percentile cut off:", min = 0, max = 100, value = 80) %>% return()
			}
		})



		observeEvent(input$done, {
			if(input$filter_type == "list")
				filtered_log <- filter_endpoints(eventlog,
												 start_activities = input$start,
												 end_activities = input$end,
												 reverse = ifelse(input$reverse == "Yes", TRUE, FALSE))
			else if(input$filter_type == "percentile") {
				filtered_log <- filter_endpoints(eventlog,
												percentage = input$percentile_slider/100,
												 reverse = ifelse(input$reverse == "Yes", TRUE, FALSE))
			}

			stopApp(filtered_log)
		})
	}
	runGadget(ui, server, viewer = dialogViewer("Filter End Points", height = 400))

}