1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
|
Python Codon Adaptation Index
=============================
An implementation of [Sharp and Li's 1987
formulation](https://www.ncbi.nlm.nih.gov/pmc/articles/PMC340524/pdf/nar00247-0410.pdf)
of the [codon adaption
index](https://en.wikipedia.org/wiki/Codon_Adaptation_Index).
Installation
------------
This module is available from PyPI and can be downloaded with the
following command:
$ pip install CAI
To install the latest development version:
$ pip install git+https://github.com/Benjamin-Lee/CodonAdaptationIndex.git
Quickstart
----------
Finding the CAI of a sequence is easy:
>>> from CAI import CAI
>>> CAI("ATG...", reference=["ATGTTT...", "ATGCGC...",...])
0.24948128951724224
Similarly, from the command line:
$ CAI -s sequence.fasta -r reference_sequences.fasta
0.24948128951724224
Determining which sequences to use as the reference set is left to the
user, though the [HEG-DB](http://genomes.urv.cat/HEG-DB/) is a great
resource of highly expressed genes.
Contributing and Getting Support
--------------------------------
If you encounter any issues using CAI, feel free to [create an
issue](https://github.com/Benjamin-Lee/CodonAdaptationIndex/issues).
To contribute to the project, please [create a pull
request](https://github.com/Benjamin-Lee/CodonAdaptationIndex/pulls).
For more information on how to do so, please look at GitHub's
[documentation on pull
requests](https://help.github.com/articles/about-pull-requests).
Citation
--------
Lee, B. D. (2018). Python Implementation of Codon Adaptation Index.
*Journal of Open Source Software, 3* (30), 905.
[<https://doi.org/10.21105/joss.00905>](https://doi.org/10.21105/joss.00905)
:
@article{Lee2018,
doi = {10.21105/joss.00905},
url = {https://doi.org/10.21105/joss.00905},
year = {2018},
month = {oct},
publisher = {The Open Journal},
volume = {3},
number = {30},
pages = {905},
author = {Benjamin D. Lee},
title = {Python Implementation of Codon Adaptation Index},
journal = {Journal of Open Source Software}
Contact
-------
I'm available for contact at
[<benjamin_lee@college.harvard.edu>](mailto:benjamin_lee@college.harvard.edu).
Reference
---------
Sharp, P. M., & Li, W. H. (1987). The codon adaptation index--a measure
of directional synonymous codon usage bias, and its potential
applications. *Nucleic Acids Research*, 15(3), 1281–1295.
|
