R/size_of_selfloops.R

In edeaR: Exploratory and Descriptive Event-Based Data Analysis

#' @title Metric: Size of selfloops
#'
#' @description Provides summary statistics on the sizes of selfloops
#'
#'
#' @inherit end_activities params
#' @inherit number_of_selfloops params
#' @inherit activity_frequency params references seealso return
#'
#' @seealso \code{\link{number_of_selfloops}}
#'
#' @concept metrics_repetition
#'
#' @export size_of_selfloops

size_of_selfloops <- function(log,
							  type = c("all", "repeat","redo"),
							  level = c("log","case","activity","resource","resource-activity"),
							  append = deprecated(),
							  append_column = NULL,
							  eventlog = deprecated()) {
	UseMethod("size_of_selfloops")
}

#' @describeIn size_of_selfloops Size of selfloops for eventlog
#' @export

size_of_selfloops.eventlog <- function(log,
									   type = c("all", "repeat","redo"),
									   level = c("log","case","activity","resource","resource-activity"),
									   append = deprecated(),
									   append_column = NULL,
									   eventlog = deprecated()){

	if(lifecycle::is_present(eventlog)) {
		lifecycle::deprecate_warn(
			when = "0.9.0",
			what = "size_of_selfloops(eventlog)",
			with = "size_of_selfloops(log)")
		log <- eventlog
	}
	append <- lifecycle_warning_append(append)


	if(all((type) == c("all", "repeat","redo")))
		message("Using default type: all")
	if(all((level) == c("log","case","activity","resource","resource-activity")))
		message("Using default level: log")

	type <- match.arg(type)
	level <- match.arg(level)

	if(is.null(append_column)) {
		append_column <- case_when(level == "case" ~ "median",
								   level == "resource" ~ "median",
								   level == "activity"~"median",
								   level == "resource-activity"~"median",
								   T ~ "NA")
	}

	if(type == "all") {
		FUN <- switch(level,
					  log = all_selfloops_size_log,
					  case = all_selfloops_size_case,
					  activity = all_selfloops_size_activity,
					  resource = all_selfloops_size_resource,
					  "resource-activity" = all_selfloops_size_resource_activity
		)
	}
	else if(type == "repeat") {
		FUN <- switch(level,
					  log = repeat_selfloops_size_log,
					  case = repeat_selfloops_size_case,
					  activity = repeat_selfloops_size_activity,
					  resource = repeat_selfloops_size_resource,
					  "resource-activity" = repeat_selfloops_size_resource_activity
		)
	}
	else if (type == "redo") {
		FUN <- switch(level,
					  log = redo_selfloops_size_log,
					  case = redo_selfloops_size_case,
					  activity = redo_selfloops_size_activity,
					  resource = redo_selfloops_size_resource,
					  "resource-activity" = redo_selfloops_size_resource_activity
		)

	}

	output <- FUN(eventlog = log)

	output <- return_metric(log, output, level, append, append_column, "size_of_selfloops", 10)
	attr(output, "type") <- type
	return(output)
}

#' @describeIn size_of_selfloops Size of selfloops for grouped eventlog
#' @export

size_of_selfloops.grouped_eventlog <- function(log,
											   type = c("repeat","redo"),
											   level = c("log","case","activity","resource","resource-acitivty"),
											   append = deprecated(),
											   append_column = NULL,
											   eventlog = deprecated()){
	if(lifecycle::is_present(eventlog)) {
		lifecycle::deprecate_warn(
			when = "0.9.0",
			what = "size_of_selfloops(eventlog)",
			with = "size_of_selfloops(log)")
		log <- eventlog
	}
	append <- lifecycle_warning_append(append)

	type <- match.arg(type)
	level <- match.arg(level)

	if(is.null(append_column)) {
		append_column <- case_when(level == "case" ~ "median",
								   level == "resource" ~ "median",
								   level == "activity"~"median",
								   level == "resource-activity"~"median",
								   T ~ "NA")
	}

	if(type == "all") {
		FUN <- switch(level,
					  log = all_selfloops_size_log,
					  case = all_selfloops_size_case,
					  activity = all_selfloops_size_activity,
					  resource = all_selfloops_size_resource,
					  "resource-activity" = all_selfloops_size_resource_activity
		)
	}
	else if(type == "repeat") {
		FUN <- switch(level,
					  log = repeat_selfloops_size_log,
					  case = repeat_selfloops_size_case,
					  activity = repeat_selfloops_size_activity,
					  resource = repeat_selfloops_size_resource,
					  "resource-activity" = repeat_selfloops_size_resource_activity
		)
	}
	else if (type == "redo") {
		FUN <- switch(level,
					  log = redo_selfloops_size_log,
					  case = redo_selfloops_size_case,
					  activity = redo_selfloops_size_activity,
					  resource = redo_selfloops_size_resource,
					  "resource-activity" = redo_selfloops_size_resource_activity
		)

	}

	output <- bupaR:::apply_grouped_fun(log, FUN, .ignore_groups = FALSE, .keep_groups = FALSE, .returns_log = FALSE)



	output <- return_metric(log, output, level, append, append_column, "size_of_selfloops", 10)
	attr(output, "type") <- type
	return(output)
}
#' @describeIn size_of_selfloops Size of selfloops for activitylog
#' @export
size_of_selfloops.activitylog <- function(log,
									   type = c("all", "repeat","redo"),
									   level = c("log","case","activity","resource","resource-activity"),
									   append = deprecated(),
									   append_column = NULL,
										eventlog = deprecated()){
	if(lifecycle::is_present(eventlog)) {
		lifecycle::deprecate_warn(
			when = "0.9.0",
			what = "size_of_selfloops(eventlog)",
			with = "size_of_selfloops(log)")
		log <- eventlog
	}
	append <- lifecycle_warning_append(append)

	log %>% to_eventlog %>% size_of_selfloops()
}

#' @describeIn size_of_selfloops Size of selfloops for grouped activitylog
#' @export
size_of_selfloops.grouped_activitylog <- function(log,
										  type = c("all", "repeat","redo"),
										  level = c("log","case","activity","resource","resource-activity"),
										  append = deprecated(),
										  append_column = NULL,
										  eventlog = deprecated()){
	if(lifecycle::is_present(eventlog)) {
		lifecycle::deprecate_warn(
			when = "0.9.0",
			what = "size_of_selfloops(eventlog)",
			with = "size_of_selfloops(log)")
		log <- eventlog
	}
	append <- lifecycle_warning_append(append)

	size_of_selfloops.grouped_eventlog(bupaR::to_eventlog(log),
									   type = type,
										level = level,
										append = append,
										append_column = append_column)
}