save_result

glotaran.plugin_system.project_io_registration.save_result(result: Result, result_path: StrOrPath, format_name: str | None = None, *, allow_overwrite: bool = False, update_source_path: bool = True, saving_options: SavingOptions = SavingOptions(data_filter=None, data_format='nc', parameter_format='csv', report=True), **kwargs: Any) → list[str][source]

Write a Result instance to a spec file.

Parameters:

  • result (Result) – Result instance to write.

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

  • format_name (str | None) – Format the result should be saved in, if not provided and it is a file it will be inferred from the file extension.

  • allow_overwrite (bool) – Whether or not to allow overwriting existing files, by default False

  • update_source_path (bool) – Whether or not to update the source_path attribute to result_path when saving. by default True

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

  • **kwargs (Any) – Additional keyword arguments passes to the save_result implementation of the project io plugin.

Returns:

List of file paths which were saved.

Return type:

list[str] | None