CodonU.analyzer.generate_report

Module Contents

Functions

_print_msg(_type, output, tot_gene)

Prints the upper message

generate_report(handle, _type, genetic_code_num, ...)

Generate the report for given sequence [best for gene analysis]
CodonU.analyzer.generate_report._print_msg(_type: str, output, tot_gene: int)

Prints the upper message

CodonU.analyzer.generate_report.generate_report(handle: str, _type: str, genetic_code_num: int, min_len_threshold: int, res_folder_path: str = 'Report')

Generate the report for given sequence [best for gene analysis]

For nucleotide sequence, this generates reports of:

  • RSCU

  • CAI

  • CBI

  • ENc

For protein sequence, this generates reports of:

  • GRAVY score

  • Aromaticity score

NOTE Possible types are

  • nuc: For nucleotide sequence

  • aa: For protein sequence

Parameters:

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

  • _type – Type of the sequence [nuc or aa]

  • genetic_code_num – Genetic table number for codon table

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

  • res_folder_path – The path of folder where the file will be saved

Returns: