Skip to content

Commit a9ae275

Browse files
committed
Added info on recent changes and how to cite paper
1 parent 4394af3 commit a9ae275

File tree

5 files changed

+35
-0
lines changed

5 files changed

+35
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,12 @@ https://metapredict.readthedocs.io/en/latest/getting_started.html
2828
For disorder predictions using our server, please see:
2929
https://metapredict.net
3030

31+
## How to cite metapredict
32+
33+
If you use metapredict for your work, please cite the metapredict paper -
34+
35+
*Emenecker RJ, Griffith D, Holehouse AS, metapredict: a fast, accurate, and easy-to-use predictor of consensus disorder and structure, Biophysical Journal (2021), doi: https:// doi.org/10.1016/j.bpj.2021.08.039.*
36+
3137

3238
## Installation:
3339

@@ -645,6 +651,13 @@ Example data that can be used with metapredict can be found in the metapredict/d
645651

646652
This section is a log of recent changes with metapredict. My hope is that as I change things, this section can help you figure out why a change was made and if it will break any of your current work flows. The first major changes were made for the 0.56 release, so tracking will start there. Reasons are not provided for bug fixes for because the reason can assumed to be fixing the bug...
647653

654+
#### V1.5
655+
656+
Changes:
657+
Fixed bug causing some functions to fail when getting sequences from Uniprot.
658+
Added information on citing metapredict because the final publication went live.
659+
660+
648661
#### V1.4
649662

650663
Change:

docs/changes.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,13 @@ About
66

77
This section is a log of recent changes with metapredict. My hope is that as I change things, this section can help you figure out why a change was made and if it will break any of your current work flows. The first major changes were made for the 0.56 release, so tracking will start there.
88

9+
V1.5
10+
-----
11+
Changes:
12+
Fixed bug causing some functions to fail when getting sequences from Uniprot.
13+
Added information on citing metapredict because the final publication went live.
14+
15+
916
V1.4
1017
-----
1118
Change:

docs/getting_started.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,14 @@ Consensus disorder scores are really useful as they distribute the biases and un
3535
The major advantages that **metapredict** offers over existing predictors is performance, ease of use, and ease of installation. Given **metapredict** uses a pre-trained bidirectional recurrent neural network, on hardware we've tested **metapredict** gives ~10,000 residues per second prediction power. This means that predicting disorder across entire proteomes is accessible in minutes - for example it takes ~20 minutes to predict disorder for every human protein in the reviewed human proteome (~23000 sequences). We provide **metapredict** as a simple-to-use Python library to integrate into existing Python workflows, and as a set of command-line tools for the stand-alone prediction of data from direct input or from FASTA files.
3636

3737

38+
How to cite metapredict
39+
===========================
40+
41+
If you use metapredict for your work, please cite the metapredict paper -
42+
43+
Emenecker RJ, Griffith D, Holehouse AS, metapredict: a fast, accurate, and easy-to-use predictor of consensus disorder and structure, Biophysical Journal (2021), doi: https:// doi.org/10.1016/j.bpj.2021.08.039.
44+
45+
3846
Installation
3947
==============
4048
**metapredict** is available through GitHub or the Python Package Index (PyPI). To install through PyPI, run

docs/how_to_cite.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
How to cite metapredict
2+
===========================
3+
4+
If you use metapredict for your work, please cite the metapredict paper -
5+
6+
Emenecker RJ, Griffith D, Holehouse AS, metapredict: a fast, accurate, and easy-to-use predictor of consensus disorder and structure, Biophysical Journal (2021), doi: https:// doi.org/10.1016/j.bpj.2021.08.039.

docs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ Welcome to metapredict's documentation!
1717
usage/acknowledgements
1818
usage/troubleshooting
1919
changes
20+
how_to_cite
2021

2122

2223

0 commit comments

Comments
 (0)