gunshotmatch_pipeline.exporters

Functions and classes for export to disk, and verification of saved data.

Functions:

verify_saved_datafile(in_process, from_file)	Verify the data in a saved Datafile matches the data in memory.
verify_saved_project(in_process, from_file)	Verify the data in a saved Project matches the data in memory.
write_combined_csv(repeat, output_dir)	Write a CSV file listing the top hits for each peak in the Repeat, with associated data.
write_matches_json(project, output_dir)	Write the JSON output file listing the determined "best match" for each peaks.

verify_saved_datafile(in_process, from_file)

Verify the data in a saved Datafile matches the data in memory.

Will raise an AssertionError if the data do not match.

Parameters

• in_process (Datafile) – The Datafile already in memory.

• from_file (Datafile) – A Datafile loaded from disk.

verify_saved_project(in_process, from_file)

Verify the data in a saved Project matches the data in memory.

Will raise an AssertionError if the data do not match.

Parameters

• in_process (Project) – The Project already in memory.

• from_file (Project) – A Project loaded from disk.

write_combined_csv(repeat, output_dir)

Write a CSV file listing the top hits for each peak in the Repeat, with associated data.

Parameters

• repeat (Repeat)

• output_dir (PathPlus) – Directory to save the file in

write_matches_json(project, output_dir)

Write the JSON output file listing the determined “best match” for each peaks.

Parameters

• project (Project)

• output_dir (PathPlus) – The directory to write the <project.name>.json file to.