pyhctsa.results.save_results¶

pyhctsa.results.save_results(path, values, quality, errors=None, calc_time=None, meta=None)¶

Write feature values and their quality labels to path (format from the suffix).

Parameters:¶

path : str or Path¶

Ends in .npz or .parquet.

values : pandas.DataFrame¶

As returned by FeatureCalculator.extract() and set in FeatureCalculator.quality: same index and columns.

quality : pandas.DataFrame¶

As returned by FeatureCalculator.extract() and set in FeatureCalculator.quality: same index and columns.

errors : pandas.DataFrame, optional¶

FeatureCalculator.errors and FeatureCalculator.calc_time.

calc_time : pandas.DataFrame, optional¶

FeatureCalculator.errors and FeatureCalculator.calc_time.

meta : dict, optional¶

Extra metadata to store (JSON-serialisable).

Returns:¶

The path of the values file.

Return type:¶

Path