expan.cli package

Submodules

expan.cli.cli module

exception expan.cli.cli.UsageError(msg)

Bases: Exception

expan.cli.cli.check_input_data(args)

Check if kpi and metadata files are provided in input arguments

expan.cli.cli.main()
expan.cli.cli.parse_metadata(filename)

Parse metadata file

Args: filename - metadata file path

expan.cli.cli.prepare_cli_parameters(args)

Parse input parameters

expan.cli.cli.print_results(delta, sga, output_file)

Print analyses results either to stdout or output file, if specified

Parameters:
  • - delta analysis results (delta) –
  • - subgroup analysis results (sga) –
  • - output file path (output_file) –
expan.cli.cli.run_analysis(features_file, kpis_file, metadata_file)

Load kpis and features from file and pass them to expan to perform delta and subgroup analyses

Parameters:
  • features_file – features file path
  • kpis_file – kpis file path
  • metadata_file – metadata file path
Returns:

delta analysis results and subgroup analysis results as a tuple
expan.cli.cli.run_expan(xxx_todo_changeme)

Triggers expan to perform delta and subgroup analyses Print response either to stdout or output file, if specified

Module contents

ExpAn Command Line Interface module.