Hw 18

README.md

@@ -1,261 +1,37 @@
-# My junior biochemical tool
-This package consists of 2 mini-tools
-`tools_for_bioinformatics` designed to work with nucleotide and amino acid sequences and FASTQ files
-`bio_files_processor` provides opportunity to  manipulate with FASTA files  
+## My first bioinformatics tools
 
+This repository contains homeworks assignments from the Python course within the "Bioinformatics for Biologists" annual program at the Institute of Bioinformatics (2023-2024). It contains python realizations of a  number of training tasks 
 
-# My junior biochemical tool
-This package for junior bioinformaticians is designed to work with nucleotide and amino acid sequences and FASTQ files, and consists of three parts. Each module `amino_acid_tools`, `dna_rna_tools` and `fastq_filtration` presents its own possibilities for sequence processing.  
-
-# `amino_acids_tools`
-This tool is designed  to work with amino acid sequences consisting of _22 proteinogenic amino acid_ residues (including pyrrolizine and selenocysteine) recorded in a standard one-letter format. It is not intended to process sequences with post-translational and other amino acid modifications
-
-## Usage  
-You call the `amino_acid_tools` function, which takes as input an arbitrary number of arguments with amino-acid sequences (str), as well as the name of the procedure to be executed (it is always the last argument, str). After that the command performs the specified action on all the given sequences. If one sequence is submitted, a string with the result is returned. If several sequences are submitted, a list of strings is returned.  
-Input sequences can contain both uppercase and lowercase letters, but the last argument with the function name must correspond to the listed functions.
-
-
-## Options  
-The following options for aminoacid sequence processing are available at the moment:
-
-- **molecular_weight**: calculate the molecular weight of the amino acid chain in Da, according to the average amino acid residues molecular masses rounded to 1 or 2 decimal places.  
-- **three_letter_code**: converts standard single letter translations to three letter translations  
-- **show_length**: count the overall number of amino acids in the given  
-- **sequence folding**: count the number of amino acids characteristic separately for alpha helixes and beta sheets,and give out what will be the structure of the protein more. This function has been tested on proteins such as 2M3X, 6DT4 (PDB ID) and MHC, CRP. The obtained results corresponded to reality.  
-- **seq_charge**: evaluates the overall charge of the aminoacid chain in neutral aqueous solution (pH = 7), according to the pKa of amino acid side chains, lysine, pyrrolizine and arginine contribute +1, while asparagine and glutamic amino acids contribute -1. The total charge of a protein is evaluated as positive, negative, or neutral as the sum of these contributions
-
-### Remarks
-If sequense contains symbols differ from IUPAC 1-letter code for 22 proteinogenic amino acids,
-the result *for this sequence* will be `'unexpected symbols in sequence'` regardless of function
-If action is not in the function the message `'unexpected action'` will occur
-
-## Examples  
-Below is an example of processing an amino acid sequence for different input data
-```Python
-amino_acid_tools('DNA', 'molecular_weight')
-```
-Output: 300.28
-
-```Python
-amino_acid_tools('DNA', 'russco', 'LOLkEk', 'azaz', 'three_letter_code')
-```
-Output: ['AspAsnAla', 'ArgSecSerSerCysPyl', 'LeuPylLeuLysGluLys', 'unexpected symbols in sequence']
-
-```Python
-amino_acid_tools('DNA', 'russco', 'LOLkEk', 'azaz', 'letter_code')
-```
-ValueError: Unexpected action
-
-### Using the function for molecular weight calculation
-
-```Python  
-amino_acid_tools('EGVIMSELKLK', 'PLPKvelPPDFVD', 'DVIGISILGKEV', 'molecular_weight')  
-```
-
-Input: 'EGVIMSELKLK', 'PLPKvelPPDFVD', 'DVIGISILGKEV', 'molecular_weight'  
-Output: '[1228.66, 1447.8400000000001, 1224.6399999999999]'
-
-### Using the function to convert one-letter translations to three-letter translations
-
-```Python  
-amino_acid_tools('EGVIMSELKLK', 'PLPKvelPPDFVD', 'DVIGISILGKEV', 'three_letter_code')  
-```
-
-Input: 'EGVIMSELKLK', 'PLPKvelPPDFVD', 'DVIGISILGKEV', 'three_letter_code'  
-Output: '['GluGlyValIleMetSerGluLeuLysLeuLys', 'ProLeuProLysValGluLeuProProAspPheValAsp', 'AspValIleGlyIleSerIleLeuGlyLysGluVal']'
-
-### Using the function to counts the number of amino acids in the given sequence
-
-```Python  
-amino_acid_tools('EGVIMSELKLK', 'PLPKvelPPDFVD', 'DVIGISILGKEV', 'show_length')  
-```
-
-Input: 'EGVIMSELKLK', 'PLPKvelPPDFVD', 'DVIGISILGKEV', 'show_length'  
-Output: '[11, 13, 12]'
-
-### Using the function to determine the predominant secondary structure
-
-```Python  
-amino_acid_tools('EGVIMSELKLK', 'PLPKvelPPDFVD', 'DVIGISILGKEV', 'folding')  
-```  
-Input: 'EGVIMSELKLK', 'PLPKvelPPDFVD', 'DVIGISILGKEV', 'folding'  
-Output: '['alfa_helix', 'equally', 'equally']'
-
-### Using the function to estimate relative charge
-
-```Python  
-amino_acid_tools('EGVIMSELKLK', 'PLPKvelPPDFVD', 'DVIGISILGKEV', 'seq_charge')  
-```
-
-Input: 'EGVIMSELKLK', 'PLPKvelPPDFVD', 'DVIGISILGKEV', 'seq_charge'  
-Output: '['neutral', 'negative', 'negative']'
-
-# `DNA_RNA_tools`
-
-This program is designed to work with nucleic acid sequences. We expect RNA and DNA chains in the standard NNNNNNNN form, without phosphate groups, in uppercase or lowercase letters
-
-### Usage
-You call the `dna_rna_tools` function, which takes as input anumber of arguments with amino-acid sequences (str), as well as the name of the procedure to be executed (it is always the last argument, str).
+### Contents:
 
-The nucleotide sequence can consist of both uppercase and lowercase letters.
-Input example:
-```Python
-dna_rna_tools('GCGGT','auccuc','GCTatGc','complement')
-```
+* ##### `main_script`:
+    * `run_genscan` function and `GenscanOutput` class: Retrieve data from the GENSCAN website (http://argonaute.mit.edu/GENSCAN.html).
+    * `telegram_logger` decorator: Sends a Telegram bot message with the function's completion time and any error messages.
+    * `fastq_filtration` function: Filters reads from FASTQ files based on length, GC content, and read quality, returning a file containing filtered sequences.
+    * `BiologicalSequence`, `NucleicAcidSequence`, `DNASequence`, `RNASequence`, `AminoAcidSequence` classes: Enable various operations on biological sequences. 
+* ##### `bio_files_processor`:
+    * `OpenFasta` class: Reads and processes multi-line FASTA files record by record, providing results in a user-friendly format using the `FastaRecord` dataclass.
+    * `convert_multiple_fasta_to_online` function: Converts a multi-line FASTA file to a single-line format.
+    * `change_fasta_start_pos` function: Shifts the starting position to a specified nucleotide.
+* ##### `test_modules.py`:
+ Contains a set of tests for the `change_fasta_start_pos` function and the `DNASequence`, `NucleicAcidSequence` classes.
+* ##### `custom_random_forest.py`:
+   An attempt to accelerate the creation of an ensemble of models using parallel programming techniques. 
+_Note: The `custom_random_forest` file is currently under development and will be added to the repository soon_. Now you can find draft notebook with realization and working examples
 
-### Functions:
-Folowing options are avaliable now:
+#### Showcases
 
- - **complement:** makes complement sequence to seq
- - **reverse**: reverses sequence, (from 5'-3' to 3' -5' there or back)
- - **reverse_complement**: makes complement sequence and reverse it
- - **transcribe**: make transcript of DNA sequence. in the case of RNA
-   sequence, no changes will be returned
+The `Showcases.ipynb` notebook provides examples of how to use the following:
 
-*Returns:*
-If one sequence is supplied, a string with the result is returned.
-If several are submitted, a list of strings is returned.
+* `telegram_logger`
+* `RunGenscan`
+* `BiologicalSequences` classes
 
-#### Remarks
-If seq contains both U(u) and T(t) the result *for this sequence* will be `"U and T in one seq"` regardless of function
+_Feedback and Contact:_
 
-If seq contains symbols differ from standardized oligonucleotide notation, the result *for this sequence* will be `'unexpected symbols in sequence'` regardless of function
-If action is not in the function the message `'unexpected action'` will occur
-
-### Examples:
-```Python
-dna_rna_tools('ATTC', 'CGcGc', 'AZA', 'atuc', 'Au', 'transcribe')
-```
-Output: ['AUUC', 'CGcGc', 'unexpected symbols in sequence', 'T and U in one seq', 'Au']
-
-
-```Python
-dna_rna_tools('ATTC', 'CGcGc', 'AZA', 'atuc', 'Au', 'revese')
-```
-ValueError: Unexpected action
-
-```Python
-dna_rna_tools('UuCG','complement')
-```
-Output: 'AaGC'
-
-# `FASTQ_filtration tool`
-
-This function provides you the opportunity to filter the FASTQ list to select sequences according to requirements on three parameters: length, GC composition, and quality of the reed
-
-### Usage
-It is required to input the list of sequences in dictionary format, as well as values for filtering parameters: interval by GC-composition, interval by sequence length, threshold value of average quality of reed. You also need input file and output file name (optional)
- **input_fastq:**  FASTQ file
-**output_fastq**  name of output file,  you can find it in fastq_filtrator_resuls directory, if name is not defined, it will be the same of the input file in `fastq_filtration_result` directory
-
-```Python
-fastq_filtration('example_fastq.fastq', , gc_bounds=(20, 40), length_bounds=(0, 2 *8), quality_treshold=10, 'outfastq_gc' )
-```
-
-####  Filtering parameters
-
- - **gc_bounds:**  interval for the of acceptable GC content, in %, *Default
-   value = (0,100)*
- - **length_bounds**:  interval for the of acceptable sequense length in
-   number of nucleotide, *Default value = (2,2**32)*
- - **quality_treshold**:  threshold value for average quality per nucleotide
-   (phred33 scale), *Default value = 0*
-
-
-### Result:
-New FASTQ file consists of selected sequences after 3-step filtration
-#### Remarks
-After running without specifying the filtering parameters, all sequences will be be selected as appropriate
-You also can specify only the upper limit for GC-content and length filtering
-
-### Examples
-```Python
-fastq_filtration('example_fastq.fastq', gc_bounds= (80, 100))
-```
-@SRX079804:1:SRR292678:1:1101:1120907:1120907 1:N:0:1 BH:ok
-CATGGTGGCG
-+SRX079804:1:SRR292678:1:1101:1120907:1120907 1:N:0:1 BH:ok
-HHHHHFHHGG
-@SRX079804:1:SRR292678:1:1101:1175112:1175112 1:N:0:1 BH:failed
-AGGCC
-+SRX079804:1:SRR292678:1:1101:1175112:1175112 1:N:0:1 BH:failed
-EC8EE
-@SRX079804:1:SRR292678:1:1101:1269735:1269735 1:N:0:1 BH:failed
-C
-+SRX079804:1:SRR292678:1:1101:1269735:1269735 1:N:0:1 BH:failed
-G
-```Python
-fastq_filtration('example_fastq.fastq', length_bounds= (8, 12),output_fastq = 'outfastq_length')
-```
-@SRX079804:1:SRR292678:1:1101:1119783:1119783 1:N:0:1 BH:failed
-TGTTGTGTCAAG
-+SRX079804:1:SRR292678:1:1101:1119783:1119783 1:N:0:1 BH:failed
-C@ABABEEEEAC
-@SRX079804:1:SRR292678:1:1101:1120614:1120614 1:N:0:1 BH:failed
-TGCTTTGCTTT
-+SRX079804:1:SRR292678:1:1101:1120614:1120614 1:N:0:1 BH:failed
-DFDD8FE@FFE
-@SRX079804:1:SRR292678:1:1101:1120907:1120907 1:N:0:1 BH:ok
-CATGGTGGCG
-+SRX079804:1:SRR292678:1:1101:1120907:1120907 1:N:0:1 BH:ok
-HHHHHFHHGG
-@SRX079804:1:SRR292678:1:1101:1130921:1130921 1:N:0:1 BH:failed
-AAGGGTCGA
-+SRX079804:1:SRR292678:1:1101:1130921:1130921 1:N:0:1 BH:failed
-D@CDDBEEB
-@SRX079804:1:SRR292678:1:1101:1156698:1156698 1:N:0:1 BH:failed
-GAAAGAAC
-+SRX079804:1:SRR292678:1:1101:1156698:1156698 1:N:0:1 BH:failed
-E=FFFFFF
-```Python
-fastq_filtration('example_fastq.fastq')
-```
-input file (no filtratation with default parameters)
-```Python
-fastq_filtration('example_fastq.fastq', gc_bounds=(100, 100), length_bounds=(0, 0 ), quality_treshold=0, output_fastq = 'outfastq_none')
-```
-empty file
-
-
-# `bio_files_processor` 
-
-works with FASTA files, provides 2 functions
-
-## `convert_multiline_fasta_to_oneline
-This function covert multiple string FASTA-file to one-long-string format
-
- - **input_fasta**:  path to the FASTA file
- - **output_fasta**: name for output FASTA-file, if not defined it will be saved to the directory `Result` as  `'Result'/input_fasta`
-
-Example input:
-```Python
-convert_multiline_fasta_to_oneline('example_multiline_fasta.fasta', 'output2'): 
-```
-
-## `change_fasta_start_pos`
+I welcome any questions, comments, or suggestions. Please feel free to reach out to me:
 
+ Maria Lukina
 
-This function moves the position to a new starting nucleotide and needs 3 parameters
-
- - **input_fasta:** data for processing (1-string single fasta)  
- - **n:** position of new start nucleotide (started with 0)
- -  **output_fasta:** name for output fasta file
-
-
-
-Example input:
-```Python 
-change_fasta_start_pos('example_fasta.fasta', 3, 'output2'): 
-```
-
-Examples:
-ACTGGA   initial sequence
-TGGAAC  n =2
-AACTGG  n =-1
-AACTGG  n = 5
-
-
+ Email: _maria.v.luk@gmail.com_    Telegram: _earthling_maria_
 
-##### Contacts
-Maria Lukina
-maria.v.luk@gmail.com