OMXFile.to_csvs#

OMXFile.to_csvs(path, format_='square', *, overwrite=False)[source]#

Export each matrix level to a CSV.

Parameters:

  • path (Path) – Base path for outputting CSVs to, actual CSV filenames will be {path.stem}-{matrix level}{path.suffix}.

  • format – Format to write all CSVs as, can be “square” or “long”.

  • overwrite (bool) – If False (default) raises a FileExistsError if any of the output CSVs already exists.

  • format_ (Literal['square', 'long'])

Returns:

Paths to written CSVs.

Return type:

list[pathlib.Path]

Raises:

  • ValueError – If CSV format is invalid.

  • FileExistsError – If overwrite is False and one (or more) of the output CSVs already exists.