Molecule Mutation Record

class MutationRecord(molecule_record, mutator_name)[source]

Bases: object

Abstract base class for a record of a mutation operation.

Notes

You might notice that the public methods of this abstract base class are implemented. This is just a default implementation, which can be used directly by users and subclasses, but can also be freely replaced during subclass implementation, if need be.

Methods

get_molecule_record()

Get the MoleculeRecord produced by the mutation.

get_mutator_name()

Get the name of the mutator which carried out the mutation.

__init__(molecule_record, mutator_name)[source]

Initialize a MutationRecord instance.

Parameters
  • molecule_record (MoleculeRecord) – The molecule produced by the mutation operation.

  • mutator_name (str) – The name of the mutator which carried out the mutator.

get_molecule_record()[source]

Get the MoleculeRecord produced by the mutation.

Returns

The molecule record.

Return type

MoleculeRecord

get_mutator_name()[source]

Get the name of the mutator which carried out the mutation.

Returns

The name of the mutator.

Return type

str