You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+14-13Lines changed: 14 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,32 +2,33 @@
2
2

3
3
4
4
5
-
CryptKeeper is a computational pipeline designed to predict the presence of open reading frames that are burdensome due to substantial ribosome sequestration on plasmids, particularly virus infectious clones. CryptKeeper also uses other prediction tools, such as promoter prediction and terminator prediction, to provide additional context. Burden from strongly expressed, long open reading frames have been found to render plasmids evolutionarily unstable or unclonable. In addition to highlighting burden from ribosome absorption, we've also found that CryptKeeper is capable of displaying alternative translation initiation sites that lead to protein truncations. This is an important consideration for experiments that rely on protein fusions or tagging.
5
+
`CryptKeeper` is a computational pipeline designed to predict the presence of open reading frames that are burdensome due to substantial ribosome sequestration on plasmids, particularly virus infectious clones. `CryptKeeper` also uses other prediction tools, such as promoter prediction and terminator prediction, to provide additional context. Burden from strongly expressed, long open reading frames have been found to render plasmids evolutionarily unstable or unclonable. In addition to highlighting burden from ribosome absorption, we've also found that `CryptKeeper` is capable of displaying alternative translation initiation sites that lead to protein truncations. This is an important consideration for experiments that rely on protein fusions or tagging.
6
6
7
7
8
-
CryptKeeper provides an output in the form of CSV files (for downstream data processing) and a Bokeh plot for interactive visualization. The Bokeh plot uses the SVG backend and can be saved to support assembling downstream figures.
8
+
`CryptKeeper` provides an output in the form of CSV files (for downstream data processing) and a Bokeh plot for interactive visualization. The Bokeh plot uses the SVG backend and can be saved to support assembling downstream figures.
9
9
10
10
11
11

12
-
Above is an example of a Bokeh plot produced by CryptKeeper. The two outer tracks display predicted RBS strength versus sequence position (the product being 'burden'). The inner tracks display predicted promoters (green), rho-dependent terminators (red), and rho-independent terminators (purple). The innermost track displays annotations extracted from the provited genbank file.
12
+
Above is an example of a Bokeh plot produced by `CryptKeeper`. The two outer tracks display predicted RBS strength versus sequence position (the product being 'burden'). The inner tracks display predicted promoters (green), rho-dependent terminators (red), and rho-independent terminators (purple). The innermost track displays annotations extracted from the provited genbank file.
13
13
14
14
15
15
# Quick Start
16
16
## Installation
17
17
18
+
[](http://bioconda.github.io/recipes/cryptkeeper/README.html)
18
19
19
-
### For Developers
20
-
CryptKeeper is currently in development. Adventurous users can install dependencies on their own through other means. The simplest way to install CryptKeeper is through conda by:
20
+
`CryptKeeper` is a Python module and associated command line script. We recommend installing `CryptKeeper` using [Bioconda](https://bioconda.github.io/) on Linux or macOS. This will automatically install `CryptKeeper` and all of its dependencies.
21
21
22
22
23
-
* Cloning this repository to your machine
24
-
*`conda env create -f environment.yml`
25
-
*`conda activate cryptkeeper`
26
-
*`pip install ./`
23
+
From Bioconda (recommended; Linux, macOS):
24
+
- Run `conda install -c bioconda cryptkeeper`
27
25
26
+
From Pip (for experts; Linux, macOS, Windows):
27
+
- Download and install ViennaRNA, following the instructions [here](https://www.tbi.univie.ac.at/RNA/).
28
+
- Download and install TranstermHP [here](https://transterm.cbcb.umd.edu/). Add TransTermHP binaries to your path.
29
+
- Run `pip install cryptkeeper`
28
30
29
-
CryptKeeper is also available through pip, but requires manual installation of ViennaRNA and an appropriate Selenium configuration (for generating SVG figures).
30
-
31
+
Developers may consider downloading and installing `CryptKeeper` other dependencies by forking their respective repositories and installing them from their repository directory.
This function returns an object that contains predictions made by CryptKeeper as well as some metadata information extracted directly from an input Genbank file if one is provided. The object has the following attributes:
92
+
This function returns an object that contains predictions made by `CryptKeeper` as well as some metadata information extracted directly from an input GenBank file if one is provided. The object has the following attributes:
92
93
93
94
94
95
*`name`: the name of the sample in the form of a `str`
0 commit comments