Diff of /README.md [000000] .. [deb8e5]

Switch to unified view

a b/README.md
1
# bio-aid
2
Package containing tools for genetic and genomic analysis in python in the Malkova Lab.
3
4
Includes a collection of functions from my other repositories for easier development of new projects
5
6
## Installation
7
The latest release of the bio-aid package can be installed through pip (https://pypi.org/project/bio-aid/) by using the following command:
8
```bash
9
pip install --upgrade bio-aid
10
```
11
bio-aid currently consists of a base module and three sub modules: `deepSeqInsH`, `MMBSearchTK`, `varaintTK`.
12
13
To easily import and access the functions inside of the bio-aid package, include the following in your `python` scripts:
14
15
```python
16
import BioAid as ba
17
```
18
## Diluter
19
This simple program calculates volumes for serial dilutions of yeast cultures, that can subsequently be used for colony plating. To access diluter, in `python` type:
20
```python
21
ba.dilute()
22
```
23
and follow instructions on the prompt.
24
25
## PopDub
26
Utillity for finding population doublings for the Telomere project.
27
28
To get results you will need to adjust initial and final population densities:
29
- set `initial_population` to the cell count on the beginning of your experiment used as inoculum.
30
- set `final_population_ml` to the /ml cell count at the time you want to measure population doublings.
31
- set `final_culture_volume` to the volume of your final culture.
32
33
Finally, run the function:
34
```python
35
ba.calculatePopulationDoublings(initial_population, final_population_ml, final_culture_volume)
36
```
37
## RepeatSearch
38
This tool allows for search of imperfect repeats (Inverted and Direct) in a DNA sequence. Diagram explaining the parameters can be found in the stand-alone repo [here](https://github.com/tvarovski/RepeatSearchTools) 
39
40
```python
41
# Set RepeatSearch parameters
42
sequence="ACGT"           # This is your nucleotide sequence to be searched for repeats
43
inverted=True             # Sets search to Inverted (True) vs Direct (False) repeats
44
min_query_length=5        # Sets min length of a query sequence
45
max_query_length=30       # Sets max length of a query sequence
46
min_spacer=0              # Set min distance between query and the repeat
47
window_size=804           # Sets window size within which the search is confined
48
imperfect_homology=True   # Set True/False, to search for imperfect/perfect homologies.
49
min_homology=0.8          # Sets minimum homology treshold (a fraction) when imperfect_homology=True,  
50
fixed_errors=1            # Sets maximum number of errors (del/sub) when imperfect_homology=True (set to False or to an integer)
51
52
# To run the Search execute the following:
53
results_dictionary = ba.searchSequenceForRepeats(
54
                         sequence=sequence,
55
                         min_query_length=min_query_length,
56
                         max_query_length=max_query_length,
57
                         min_spacer=min_spacer,
58
                         window_size=window_size,
59
                         imperfect_homology=imperfect_homology,
60
                         min_homology=min_homology,
61
                         fixed_errors=fixed_errors,
62
                         inverted=inverted)
63
64
```
65
66