resolve_data: Process RBC

In migrbc: Production Rules Based Classification of Migration

Description

This function is the key function to do the rules based classification.

Usage

resolve_data(grouped_data, window_size = 487, threshold_year = 365,
  parallel = FALSE, n_core = 2, include_error_columns = FALSE,
  mc.cleanup = FALSE)

Arguments

grouped_data	A list of data frame objects.
window_size	The maximum length of the scanning period. Can be an integer giving the number of days, the result of a call to function difftime, or an object of class Duration.
threshold_year	The length of the yearly test period. Can be an integer giving the number of days, the result of a call to function difftime, or an object of class Duration.
parallel	Optional, if it is TRUE, run on parallel.
n_core	if parallel set to TRUE, this will specify the number of computer cores required.
include_error_columns	Optional, if it is TRUE, the returned result of error_data will contain two extra columns error_code and error_message.
mc.cleanup	if set to TRUE then all children that have been forked by this function will be killed (by sending SIGTERM) before this function returns. Under normal circumstances mclapply waits for the children to deliver results, so this option usually has only effect when mclapply is interrupted. If set to FALSE then child processes are collected, but not forcefully terminated. As a special case this argument can be set to the number of the signal that should be used to kill the children instead of SIGTERM.

Value

A list type of object that contains a classified journey dataframe object and a error dataframe object.

Examples

## to suppresse log messages to the console
migrbc::initialize_logger(log_level = 1)

number_of_people = 10
person_data <- migrbc::setup_random_test_data(number_of_people, 
                                 initial_date = '2001-01-01', 
                                 numJourneys = 5,
                                 min = 0, 
                                 max = 10)
crossings <- migrbc::pre_process(person_data, n_groups = 10)
crossings
cross_spaces <- migrbc::resolve_data(crossings)
cross_spaces

migrbc documentation built on July 1, 2020, 8:14 p.m.