viola.Bedpe.annotate_bed

Bedpe.annotate_bed(bed, annotation, suffix=['left', 'right'])

Annotate SV breakpoints using Bed class object. Annotation is stored as INFO table. For each SV record, two annotations will be made.

Parameters

• bed (Bed) – A Bed class object for annotation.

• annotation (str) – The label of annotation. The suffixes will be attached then added as INFO table.

• how (str ['flag', 'value'], default 'flag') – If ‘flag’, Annotate True when a breakend is in Bed, otherwise False. If ‘value’, Annotate values in the Bed.

• suffix (List[str], default ['left', 'right']) – The suffix that attached after annotation label specified above.