Skip to content

Load And Save Data

This page highlights the most often used API functionalities and is not complete. It covers the most-used emzed.io helpers for loading and saving tables and mass-spectrometry data. For complete coverage, see the API Reference.

load_table(path=None)

Load table in emzed format.

Parameters:

Name Type Description Default
path

Path to the file to load (str or pathlib.Path). If not specified and if emzed_gui is installed a user dialog will pop up and ask for the file.

 None

Returns:

Type Description

emzed.Table

save_table(table, path=None, *, overwrite=False)

Save table in emzed format.

Parameters:

Name Type Description Default
table

Instance of emzed.Table.

 required
path

Target file location. If not specified and if emzed_gui is installed a user dialog will pop up asking for the destination.

 None
overwrite

Enforce overwriting if file already exists.

 False

load_peak_map(path=None)

Load peak-map.

Parameters:

Name Type Description Default
path

Path to the file to load (str or pathlib.Path). If not specified and if emzed_gui is installed a user dialog will pop up and ask for the file.

 None

Returns:

Type Description

emzed.PeakMap

load_csv(path=None, *, delimiter=';', dash_is_none=True)

Load CSV file.

Parameters:

Name Type Description Default
path

Path to the file to load (str or pathlib.Path). If not specified and if emzed_gui is installed a user dialog will pop up and ask for the file.

 None
delimiter

CSV field delimiter

 ';'
dash_is_none

If set to True the value - will be interpreted as None (missing value).

 True

Returns:

Type Description

emzed.Table

load_excel(path=None)

Load Excel file.

Parameters:

Name Type Description Default
path

Path to the file to load (str or pathlib.Path). If not specified and if emzed_gui is installed a user dialog will pop up and ask for the file.

 None

Returns:

Type Description

emzed.Table