DropPaths#

Data processor#

class retentioneering.data_processors_lib.drop_paths.DropPaths(params)[source]#

Filter user paths based on the path length, removing the paths that are shorter than the specified number of events or time.

Parameters:
min_stepsint, optional

Minimum user path length measured in the number of events.

min_timeTuple(float, DATETIME_UNITS), optional

Minimum user path length and its unit of measure.

Returns:
Eventstream

Eventstream with events that should be deleted from input eventstream marked _deleted=True.

Raises:
ValueError

If both of min_steps and min_time are empty or both are given.

See also

TimedeltaHist

Plot the distribution of the time deltas between two events.

UserLifetimeHist

Plot the distribution of user lifetimes.

Notes

See Data processors user guide for the details.

class retentioneering.data_processors_lib.drop_paths.DropPathsParams(*, min_steps=None, min_time=None)[source]#

A class with parameters for DropPaths class.

Eventstream#

DropPathsHelperMixin.drop_paths(min_steps=None, min_time=None)[source]#

A method of Eventstream class that deletes users’ paths that are shorter than the specified number of events or cut_off.

Parameters:
min_stepsint, optional

Minimum user path length measured in the number of events.

min_timeTuple(float, DATETIME_UNITS), optional

Minimum user path length and its unit of measure.

Returns:
Eventstream

Input eventstream without the deleted short users’ paths.