start

lsframe.start.start(directory=None, patterns=None, skip=None, date_format=None, classifiers=None, function=None, function_args=None)

start class for creating the object used by lrengine

Parameters
  • directory (str) -- The path to the parent directory, or .csv that can be made into a Pandas DataFrame

  • patterns (str, list, or dict) -- pattern(s) to recognize in file or folder name (see docs)

  • skip (str or list) -- pattern(s) used to decide which elements to skip

  • date_format (str or list) -- format(s) of date strings to search for

  • classifiers (list) -- User-defined classifier(s)

  • function (function) -- User-supplied function that returns classifier value(s) as list

  • function_args (dict) -- Dictionary of arguments for user-defined function

Returns

start object