Package bupar. March 21, 2018

Transcription

1 Type Package Title Business Process Analysis in R Version Date Package bupar March 21, 2018 Comprehensive Business Process Analysis toolkit. Creates S3-class for event log objects, and related handler functions. Imports related packages for filtering event data, computation of descriptive statistics, handling of 'Petri Net' objects and visualization of process maps. See also packages 'edear','processmapr', 'eventdatar' and 'processmonitr'. License MIT + file LICENSE Encoding UTF-8 LazyData true RoxygenNote Imports magrittr, dplyr, data.table, shiny, miniui, purrr, tidyr, glue, forcats, rlang, eventdatar (>= 0.2.0) URL Suggests testthat NeedsCompilation no Author Gert Janssenswillen [aut, cre] Maintainer Gert Janssenswillen <gert.janssenswillen@uhasselt.be> Repository CRAN Date/Publication :35:09 UTC R topics documented: activities activities_to_ activity_id activity_instance_id activity_labels act_collapse

2 2 activities act_recode act_unite bupar cases case_id case_labels case_list durations filter_attributes group_by_activity group_by_activity_instance group_by_case group_by_resource group_by_resource_activity lifecycle_id mapping n_activities n_activity_instances n_cases n_events n_resources n_traces print print._mapping resources resource_id resource_labels re_map simple_ summary timestamp traces trace_list ungroup_ Index 29 activities Activities Returns a tbl_df containing a list of all activity types in the event log, with their absolute and relative frequency

3 activities_to_ 3 activities() activities() ## S3 method for class 'grouped_' activities() The event log to be used. An object of class. : Generate activity list for grouped_: Generate activity list for grouped activity_id,activity_instance_id, activities_to_ Create event log from list of activity instances Create event log from list of activity instances activities_to_(activity_log, case_id, activity_id, resource_id, timestamps) activity_log case_id activity_id resource_id timestamps A data.frame where each row is an activity instances Column name of the case identifier Column name of the activity identifier Column name of the resource identifier A vector of column names containing different timestamp. To column names will be transformed to lifecycle identifiers

4 4 activity_instance_id activity_id Activity classifier Get the activity classifier of an object of class. activity_id(x) activity_id(x) ## S3 method for class '_mapping' activity_id(x) x An of _mapping : Retrieve activity identifier from _mapping: Retrieve activity identifier from mapping, mapping Other Eventlog classifiers: activity_instance_id, case_id, lifecycle_id, mapping, resource_id, timestamp activity_instance_id Activity instance classifier Get the activity instance classifier of an object of class.

5 activity_labels 5 activity_instance_id(x) activity_instance_id(x) ## S3 method for class '_mapping' activity_instance_id(x) x An of _mapping : Retrieve activity instance identifier from _mapping: Retrieve activity instance identifier from mapping Other Eventlog classifiers: activity_id, case_id, lifecycle_id, mapping, resource_id, timestamp activity_labels Get vector of activity labels Retrieve a vector containing all unique activity labels activity_labels() activity_labels() Eventlog : Retrieve activity labels from

6 6 act_recode act_collapse Collapse activity labels of a sub process into a single activity Collapse activity labels of a sub process into a single activity act_collapse(,...) act_collapse(,...) An object... A series of named character vectors. The activity labels in each vector will be collapsed into one activity with the name of the vector. : Collapse activity labels of a subprocess into a single activity Other Activity processing functions: act_recode, act_unite act_recode Recode activity labels Recode one or more activity labels through specifying their old and new label act_recode(,...) act_recode(,...)

7 act_unite 7 An object of class.... A sequence of named character vectors of length one where the names gives the new label and the value gives the old label. Labels not mentioned will be left unchanged. : Recode activity labels of event log, activity_id, act_unite Other Activity processing functions: act_collapse, act_unite act_unite Unite activity labels Recode two or different more activity labels two a uniform activity label act_unite(,...) act_unite(,...) An object of class.... A series of named character vectors. The activity labels in each vector will be replaced with the name. : Unite activity labels in event log, activity_id, act_recode Other Activity processing functions: act_collapse, act_recode

8 8 cases bupar bupar - Business Process Analysis in R Functionalities for process analysis in R. This packages implements an S3-class for event log objects, and related handler functions. Imports related packages for subsetting event data, computation of descriptive statistics, handling of Petri Net objects and visualization of process maps. cases Cases Provides a fine-grained summary of an event log with characteristics for each case: the number of events, the number of activity types, the timespan, the trace, the duration and the first and last event type. cases() cases() An object.. : Constructy list of cases in an

9 case_id 9 case_id Case classifier Get the case classifier of an object of class case_id(x) case_id(x) ## S3 method for class '_mapping' case_id(x) x An of _mapping : Retrieve case identifier from _mapping: Retrieve case identifier from mapping, mapping Other Eventlog classifiers: activity_id, activity_instance_id, lifecycle_id, mapping, resource_id, timestamp case_labels Get vector of case labels Retrieve a vector containing all unique case labels case_labels() case_labels()

10 10 durations Eventlog : Retrieve case labels from case_list Case list Construct list of cases case_list() case_list() Eventlog object : Return case list durations Durations Computes the throughput times of each case. Throughput time is defined as the interval between the start of the first event and the completion of the last event. durations(, units) durations(, units = "days")

11 11 units The event log to be used. An object of class. The time unit in which the throughput times should be reported. : Compute durations from Eventlog A function to instantiate an object of class by specifying a data.frame or tbl_df and appropriate case, activity and timestamp classifiers. (, case_id = NULL, activity_id = NULL, activity_instance_id = NULL, lifecycle_id = NULL, timestamp = NULL, resource_id = NULL, order = "auto") i() case_id The data object to be used as event log. This can be a data.frame or tbl_df. The case classifier of the event log. A character vector containing variable names of length 1 or more. activity_id The activity classifier of the event log. A character vector containing variable names of length 1 or more. activity_instance_id The activity instance classifier of the event log. lifecycle_id timestamp resource_id order The life cycle classifier of the event log. The timestamp of the event log. Should refer to a Date or POSIXct field. The resource identifier of the event log. A character vector containing variable names of length 1 or more. 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 alpabath, providing a column name will use this column for ordering (can be numeric of character). The latter will never overrule timestamp orderings. case_id, activity_id, activity_instance_id,lifecycle_id, timestamp

12 12 filter_attributes Examples ## Not run: data <- data.frame(case = rep("a",5), activity_id = c("a","b","c","d","e"), activity_instance_id = 1:5, lifecycle_id = rep("complete",5), timestamp = 1:5, resource = rep("resource 1", 5)) (data,case_id = "case", activity_id = "activity_id", activity_instance_id = "activity_instance_id", lifecycle_id = "lifecycle_id", timestamp = "timestamp", resource_id = "resource") ## End(Not run) filter_attributes Generic filter function for Generic filter function for filter_attributes(,...) filter_attributes(,...) ## S3 method for class 'grouped_' filter_attributes(,...) Eventlog object... Filter conditions : Filter using attributes grouped_: Filter grouped using attributes

13 group_by_activity 13 group_by_activity Group event log on activity id Group an event log by activity identifier group_by_activity() group_by_activity() Eventlog : Group on activity identifier group_by_activity_instance Group event log on activity instance id Group an event log by activity instance identifier group_by_activity_instance() group_by_activity_instance() Eventlog : Group on activity instance identifier

14 14 group_by_resource group_by_case Group event log on case id Group an event log by case identifier group_by_case() group_by_case() Eventlog : Group on case identifier group_by_resource Group event log on resource id Group an event log by resource identifier group_by_resource() group_by_resource() Eventlog : Group on resource identifier

15 group_by_resource_activity 15 group_by_resource_activity Group event log on resource and activity id Group an event log by resource and activity identifier group_by_resource_activity() group_by_resource_activity() Eventlog : Group an event log by resource and activity identifier lifecycle_id Life cycle classifier Get the life_cycle_id of an object of class lifecycle_id(x) lifecycle_id(x) ## S3 method for class '_mapping' lifecycle_id(x) x An of _mapping

16 16 mapping : Retrieve lifecycle identifier from _mapping: Retrieve lifecycle identifier from mapping Other Eventlog classifiers: activity_id, activity_instance_id, case_id, mapping, resource_id, timestamp mapping Mapping Prints the mapping of an event log object. mapping() mapping() The event log to be used. An object of class. : Retrieve identifier mapping from Other Eventlog classifiers: activity_id, activity_instance_id, case_id, lifecycle_id, resource_id, timestamp

17 n_activities 17 n_activities n_activities Returns the number of activities in an event log n_activities() n_activities() ## S3 method for class 'grouped_' n_activities() The event log to be used. An object of class. : Count the number of activities in an event log grouped_: Count the number of activities for a grouped event log Other Eventlog count functions: n_activity_instances, n_cases, n_events, n_resources, n_traces n_activity_instances n_activity_instances Returns the number of activity instances in an event log n_activity_instances() n_activity_instances() ## S3 method for class 'grouped_' n_activity_instances()

18 18 n_cases The event log to be used. An object of class. Other Eventlog count functions: n_activities, n_cases, n_events, n_resources, n_traces n_cases n_cases Returns the number of cases in an event log n_cases() n_cases() ## S3 method for class 'grouped_' n_cases() The event log to be used. An object of class. : Count number of cases for grouped_: Count number of cases for grouped Other Eventlog count functions: n_activities, n_activity_instances, n_events, n_resources, n_traces

19 n_events 19 n_events n_events Returns the number of events in an event log n_events() n_events() ## S3 method for class 'grouped_' n_events() The event log to be used. An object of class. : Count number of resources in grouped_: Count number of resource in Other Eventlog count functions: n_activities, n_activity_instances, n_cases, n_resources, n_traces n_resources n_resources Returns the number of resources in an event log n_resources() n_resources() ## S3 method for class 'grouped_' n_resources()

20 20 n_traces The event log to be used. An object of class. : Count number of resources in grouped_: Count number of resources in grouped Other Eventlog count functions: n_activities, n_activity_instances, n_cases, n_events, n_traces n_traces n_traces Returns the number of traces in an event log n_traces() n_traces() ## S3 method for class 'grouped_' n_traces() The event log to be used. An object of class. : Count number of traces for grouped_: Count number of traces for grouped Other Eventlog count functions: n_activities, n_activity_instances, n_cases, n_events, n_resources

21 print. 21 print. Generic print function for Generic print function for print(x,...) x Eventlog object... Additional print._mapping Generic print function for _mapping Generic print function for _mapping ## S3 method for class '_mapping' print(x,...) x Eventlog mapping object... Additional

22 22 resource_id resources Resources Returns a tbl_df containing a list of all resources in the event log, with there absolute and relative frequency resources() resources() ## S3 method for class 'grouped_' resources() The event log to be used. An object of class. : Generate resource list for grouped_: Generate resource list for grouped resource_id, resource_id Resource classifier Get the resource classifier of an object of class. resource_id(x) resource_id(x) ## S3 method for class '_mapping' resource_id(x)

23 resource_labels 23 x An of _mapping : Retrieve resource identifier from _mapping: Retrieve resource identifier from mapping, mapping Other Eventlog classifiers: activity_id, activity_instance_id, case_id, lifecycle_id, mapping, timestamp resource_labels Get vector of resource labels Retrieve a vector containing all unique resource labels resource_labels() resource_labels() Eventlog : Retrieve resource labels from

24 24 simple_ re_map Re map Construct and using an existing mapping. re_map(, _mapping) The event log data to be used. _mapping An existing mapping created by the mapping function simple_ Simple Eventlog A function to instantiate an object of class by specifying a data.frame or tbl_df and the minimally required case identifier, activity identifier and timestamp simple_(, case_id = NULL, activity_id = NULL, timestamp = NULL, order = "auto") isimple_() case_id activity_id timestamp order The data object to be used as event log. This can be a data.frame or tbl_df. The case classifier of the event log. The activity classifier of the event log. The timestamp of the event log. 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 alpabath, providing a column name will use this column for ordering (can be numeric of character). The latter will never overrule timestamp orderings.

25 summary. 25,case_id, activity_id, activity_instance_id,lifecycle_id, timestamp Examples ## Not run: data <- data.frame(case = rep("a",5), activity_id = c("a","b","c","d","e"), timestamp = date_decimal(1:5)) simple_(data,case_id = "case", activity_id = "activity_id", timestamp = "timestamp") ## End(Not run) summary. Generic summary function for class Generic summary function for class summary(object,...) ## S3 method for class 'grouped_' summary(object,...) object Eventlog object... Additional grouped_: Summary of grouped event log

26 26 traces timestamp Timestamp classifier Get the timestamp classifier of an object of class timestamp(x) timestamp(x) ## S3 method for class '_mapping' timestamp(x) x An of _mapping : Retrieve timestamp identifier from _mapping: Retrieve timestamp identifier from mapping, mapping Other Eventlog classifiers: activity_id, activity_instance_id, case_id, lifecycle_id, mapping, resource_id traces Traces traces computes the different activity sequences of an event log together with their absolute and relative frequencies. Activity sequences are based on the start timestamp of activities.

27 trace_list 27 traces(,...) traces(,...) ## S3 method for class 'grouped_' traces(,...) The event log to be used. An object of class.... Deprecated arguments : Construct traces list for grouped_: Construct list of traces for grouped cases, trace_list Trace list Construct trace list trace_list() trace_list() Eventlog object : Construct trace list for event log

28 28 ungroup_ ungroup_ Ungroup event log Remove groups from event log ungroup_() ungroup_() Eventlog : Remove groups from event log

29 Index act_collapse, 6, 7 act_recode, 6, 6, 7 act_unite, 6, 7, 7 activities, 2 activities_to_, 3 activity_id, 3, 4, 5, 7, 9, 11, 16, 23, 25, 26 activity_instance_id, 3, 4, 4, 9, 11, 16, 23, 25, 26 activity_labels, 5 bupar, 8 bupar-package (bupar), 8 case_id, 4, 5, 9, 11, 16, 23, 25, 26 case_labels, 9 case_list, 10 cases, 8, 27 durations, 10, 3, 4, 7, 9, 11, 22, 23, n_resources, 17 19, 19, 20 n_traces, 17 20, 20 print., 21 print._mapping, 21 re_map, 24 resource_id, 4, 5, 9, 16, 22, 22, 26 resource_labels, 23 resources, 22 simple_, 24 summary., 25 summary.grouped_ (summary.), 25 timestamp, 4, 5, 9, 11, 16, 23, 25, 26 trace_list, 27 traces, 26 ungroup_, 28 filter_attributes, 12 group_by_activity, 13 group_by_activity_instance, 13 group_by_case, 14 group_by_resource, 14 group_by_resource_activity, 15 i (), 11 isimple_ (simple_), 24 lifecycle_id, 4, 5, 9, 11, 15, 16, 23, 25, 26 mapping, 4, 5, 9, 16, 16, 23, 26 n_activities, 17, n_activity_instances, 17, 17, n_cases, 17, 18, 18, 19, 20 n_events, 17, 18, 19, 20 29