CodonU.analyzer.aromaticity_comp

Module Contents

Functions

calculate_aromaticity(→ dict[str, float] | float)

Calculates the aromaticity score for a given protein sequence according to Lobry (1994)
CodonU.analyzer.aromaticity_comp.calculate_aromaticity(handle: str, min_len_threshold: int = 66, gene_analysis: bool = False, save_file: bool = False, file_name: str = 'Aroma_report', folder_path: str = 'Report') → dict[str, float] | float

Calculates the aromaticity score for a given protein sequence according to Lobry (1994)

Parameters:

  • handle – Handle to the file, or the filename as a string

  • min_len_threshold – Minimum length of protein sequence to be considered as gene

  • gene_analysis – Option if gene analysis (True) or genome analysis (False) (optional)

  • save_file – Option for saving the values in xlsx format (Optional)

  • file_name – Intended file name (Optional)

  • folder_path – Folder path where image should be saved (optional)

Returns:

The aromaticity score of given sequence if gene_analysis is false, else the dictionary containing

gene number and corresponding GRAVY score