primap2.pm2io.read_interchange_format

primap2.pm2io.read_interchange_format#

primap2.pm2io.read_interchange_format(filepath: str | Path) DataFrame[source]#

Read a dataset in the interchange format from disk into memory.

Reads an interchange format dataset from disk. The data is stored in a csv file while the additional metadata is stored in a yaml file. This function takes the yaml file as parameter, the data file is specified in the yaml file. If no or a wrong ending is given the function tries to load a file by the same name with the ending .yaml.

Parameters:
filepath: str or pathlib.Path

path and filename for the dataset (the yaml file, not data file).

Returns:
data: pandas.DataFrame

DataFrame with the read data in PRIMAP2 interchange format