Skip to content
GitLab
Menu
Projects
Groups
Snippets
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
Martin Larralde
peptides.py
Commits
51b0632e
Commit
51b0632e
authored
Oct 25, 2021
by
Martin Larralde
Browse files
Improve `README.md` with list of features and reference to documentation
parent
81f0542f
Changes
2
Hide whitespace changes
Inline
Side-by-side
README.md
View file @
51b0632e
...
...
@@ -4,11 +4,11 @@
[

](https://github.com/althonos/peptides.py/actions)
[

](https://codecov.io/gh/althonos/peptides.py/)
[

](https://choosealicense.com/licenses/gpl-3.0/)
[

](https://pypi.org/project/peptides)
[

](https://pypi.org/project/peptides/#files)
[

](https://pypi.org/project/peptides/#files)
[

](https://pypi.org/project/peptides/#files)
[

](https://choosealicense.com/licenses/gpl-3.0/)
[

](https://github.com/althonos/peptides.py/)
[

](https://git.embl.de/larralde/peptides.py/)
[

](https://github.com/althonos/peptides.py/issues)
...
...
@@ -27,6 +27,29 @@ some additional features from [EMBOSS](http://emboss.bioinformatics.nl/cgi-bin/e
This library has no external dependency and is available for all modern Python
versions (3.6+).
### 📋 Features
A non-exhaustive list of available features:
-
Peptide statistics: amino acid counts and frequencies.
-
**QSAR**
descriptors: BLOSUM indices, Cruciani properties, FASGAI vectors, Kidera factors, MS-WHIM scores, PCP descriptors, ProtFP descriptors, Sneath vectors, ST-scales, T-scales, VHSE-scales, Z-scales.
-
Sequence profiles: hydrophobicity, hydrophobic moment, membrane position.
-
Physicochemical properties: aliphatic index, instability index, theoretical net charge, isoelectric point, molecular weight (with isotope labelling support).
-
Biological properties: structural class prediction.
*
If this library is missing a useful statistic or descriptor, feel free to
reach out and open a feature request on the
[
issue tracker
](
https://github.com/althonos/peptides.py/issues
)
of the
[
project repository
](
https://github.com/althonos/peptides.py
)
.
*
### 🧊 Vectorization
Most of the descriptors for a protein sequence are simple averages of values
taken in a lookup table, so computing them can be done in a vectorized manner.
If
[
`numpy`
](
https://numpy.org/
)
can be imported, relevant functions
(like
`numpy.sum`
or
`numpy.take`
) will be used, otherwise a fallback
implementation using
[
`array.array`
](
https://docs.python.org/3/library/array.html#array.array
)
from the standard library is available.
## 🔧 Installing
Install the
`peptides`
package directly from
[
PyPi
](
https://pypi.org/project/peptides
)
...
...
@@ -42,6 +65,16 @@ package:
$
conda
install
-c
bioconda peptides-py
```
-->
## 📖 Documentation
A complete
[
API reference
](
https://peptides.readthedocs.io/en/stable/api.html
)
can be found in the
[
online documentation
](
https://peptides.readthedocs.io/
)
,
or directly from the command line using
[
`pydoc`
](
https://docs.python.org/3/library/pydoc.html
)
:
```
console
$
pydoc peptides.Peptide
```
## 💡 Example
Start by creating a
`Peptide`
object from a protein sequence:
...
...
docs/index.rst
View file @
51b0632e
...
...
@@ -93,7 +93,7 @@ A non-exhaustive list of available features:
- Hydrophobic moment profile based on `Eisenberg, Weiss and Terwilliger (1984) <https://doi.org/10.1073/pnas.81.1.140>`_.
- Membrane position based on `Eisenberg (1984) <https://doi.org/10.1146/annurev.bi.53.070184.003115>`_.
- Physic
o
-chemical properties:
- Physic
al
-chemical properties:
- Aliphatic index proposed in `Ikai (1980) <https://pubmed.ncbi.nlm.nih.gov/7462208/>`_.
- Instability index proposed in `Boman (2003) <https://doi.org/10.1046/j.1365-2796.2003.01228.x>`_.
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment