Output Formatting

This module contains functions to generate csv reports of measures calculated for experiments.

sideeye.output.measure_output(measure: str, cutoff: int, columns: Dict[str, sideeye.config.OutputColumnConfig], experiment: sideeye.data.experiment.Experiment, trial: sideeye.data.trial.Trial, region: Optional[sideeye.data.region.Region]) → str

Generates a formatted output string for an individual measure.

Parameters:
  • measure (str) – Name of measure.
  • cutoff (int) – Cutoff value for measure. Use -1 for no cutoff.
  • columns (Dict[str, Dict]) – Dict of columns to output.
  • experiment (Experiment) – Experiment to generate output string for.
  • trial (Trial) – Trial to generate output for.
  • region (Optional[Region]) – Region to generate output for.
sideeye.output.generate_region_output(experiments: List[sideeye.data.experiment.Experiment], config: sideeye.config.Configuration = <sideeye.config.Configuration object>) → str

Generates a string in csv format of a list of experiments’ region measures using columns specified in config file.

Parameters:
sideeye.output.generate_trial_output(experiments: List[sideeye.data.experiment.Experiment], config: sideeye.config.Configuration = <sideeye.config.Configuration object>) → str

Generates a string in csv format of list of experiments’ trial measures using columns and measures specified in config file.

Parameters:
sideeye.output.generate_all_output(experiments: List[sideeye.data.experiment.Experiment], config: sideeye.config.Configuration = <sideeye.config.Configuration object>) → str

Generates a string in csv format of all measures specified in config file for a list of experiments. :param experiments: List of experiments. :type experiments: List[Experiment] :param config: Configuration. :type config: Configuration

sideeye.output.generate_all_output_wide_format(experiments: List[sideeye.data.experiment.Experiment], config: sideeye.config.Configuration = <sideeye.config.Configuration object>) → str

Generates a string in csv format of all measures specified in config file for a list of experiments, with all measures as columns.

Parameters: