TsvProjectIo

class glotaran.builtin.io.pandas.tsv.TsvProjectIo(format_name: str)[source]

Bases: glotaran.io.interface.ProjectIoInterface

Plugin for TSV data io.

Initialize a Project IO plugin with the name of the format.

Parameters

format_name (str) – Name of the supported format an instance uses.

Methods Summary

load_model

Create a Model instance from the specs defined in a file (NOT IMPLEMENTED).

load_parameters

Load parameters from TSV file.

load_result

Create a Result instance from the specs defined in a file (NOT IMPLEMENTED).

load_scheme

Create a Scheme instance from the specs defined in a file (NOT IMPLEMENTED).

save_model

Save a Model instance to a spec file (NOT IMPLEMENTED).

save_parameters

Save a ParameterGroup to a TSV file.

save_result

Save a Result instance to a spec file (NOT IMPLEMENTED).

save_scheme

Save a Scheme instance to a spec file (NOT IMPLEMENTED).

Methods Documentation

load_model(file_name: str) → Model

Create a Model instance from the specs defined in a file (NOT IMPLEMENTED).

Parameters

file_name (str) – File containing the model specs.

Returns

Model instance created from the file.

Return type

Model

load_parameters(file_name: str) → ParameterGroup[source]

Load parameters from TSV file.

Parameters

file_name (str) – Name of file to be loaded.

Return type

class:`ParameterGroup

load_result(result_path: str) → Result

Create a Result instance from the specs defined in a file (NOT IMPLEMENTED).

Parameters

result_path (str) – Path containing the result data.

Returns

Result instance created from the file.

Return type

Result

load_scheme(file_name: str) → Scheme

Create a Scheme instance from the specs defined in a file (NOT IMPLEMENTED).

Parameters

file_name (str) – File containing the parameter specs.

Returns

  • Scheme – Scheme instance created from the file.

  • .. # noqa (DAR202)

  • .. # noqa (DAR401)

save_model(model: Model, file_name: str)

Save a Model instance to a spec file (NOT IMPLEMENTED).

Parameters

  • model (Model) – Model instance to save to specs file.

  • file_name (str) – File to write the model specs to.

save_parameters(parameters: ParameterGroup, file_name: str, *, as_optimized: bool = True, replace_infinfinity: bool = True) → None[source]

Save a ParameterGroup to a TSV file.

Parameters

  • parameters (ParameterGroup) – Parameters to be saved to file.

  • file_name (str) – File to write the parameters to.

  • as_optimized (bool) – Whether to include properties which are the result of optimization.

  • replace_infinfinity (bool) – Weather to replace infinity values with empty strings.

save_result(result: Result, result_path: str, *, saving_options: SavingOptions = SavingOptions(data_filter=None, data_format='nc', parameter_format='csv', report=True)) → list[str]

Save a Result instance to a spec file (NOT IMPLEMENTED).

Parameters

  • result (Result) – Result instance to save to specs file.

  • result_path (str) – Path to write the result data to.

  • saving_options (SavingOptions) – Options for the saved result.

save_scheme(scheme: Scheme, file_name: str)

Save a Scheme instance to a spec file (NOT IMPLEMENTED).

Parameters

  • scheme (Scheme) – Scheme instance to save to specs file.

  • file_name (str) – File to write the scheme specs to.