genomepair

Represents a structure to pair two Genome objects and perform comparisons between them to identify inconsistencies.

class pdm_utils.classes.genomepair.GenomePair

Bases: object

compare_attribute(attribute, expect_same=False, eval_id=None, success='correct', fail='error', eval_def=None)

Compare values of the specified attribute in each genome.

Parameters
  • attribute (str) – Name of the GenomePair object attribute to evaluate.

  • expect_same (bool) – Indicates whether the two attribute values are expected to be the same.

  • eval_id (str) – Unique identifier for the evaluation.

  • success (str) – Default status if the outcome is a success.

  • fail (str) – Default status if the outcome is not a success.

  • eval_def (str) – Description of the evaluation.

compare_date(expect, eval_id=None, success='correct', fail='error', eval_def=None)

Compare the date of each genome.

Parameters
  • expect (str) – Is the first genome expected to be “newer”, “equal”, or “older” than the second genome.

  • eval_id – same as for compare_attribute().

  • success – same as for compare_attribute().

  • fail – same as for compare_attribute().

  • eval_def – same as for compare_attribute().

set_eval(eval_id, definition, result, status)

Constructs and adds an Evaluation object to the evaluations list.

Parameters
  • eval_id (str) – Unique identifier for the evaluation.

  • definition (str) – Description of the evaluation.

  • result (str) – Description of the outcome of the evaluation.

  • status (str) – Outcome of the evaluation.