Skip to content

Commit afd4cad

Browse files
committed
Update README install instructions
1 parent 9b9a24d commit afd4cad

File tree

1 file changed

+14
-13
lines changed

1 file changed

+14
-13
lines changed

README.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,32 +2,33 @@
22
![CryptKeeper logo with name](./cryptkeeper/assets/cryptkeeper_long.svg)
33

44

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.
66

77

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.
99

1010

1111
![Example CryptKeeper output of a medium strength BFP expression plasmid.](./examples/output.png)
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.
1313

1414

1515
# Quick Start
1616
## Installation
1717

18+
[![install with bioconda](https://img.shields.io/badge/install%20with-bioconda-brightgreen.svg?style=flat)](http://bioconda.github.io/recipes/cryptkeeper/README.html)
1819

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.
2121

2222

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`
2725

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`
2830

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.
3132

3233
## Command Line Usage Usage
3334

@@ -66,7 +67,7 @@ cryptkeeper -i pSMART-LCKan-BPMV1.fna -o output/pSMART-LCKan-BPMV1 -j 8 -c
6667
## Python Usage
6768

6869

69-
In certain situations, it may be valuable to use CryptKeeper as a python dependency for another pipeline.
70+
In certain situations, it may be valuable to use `CryptKeeper` as a python dependency for another pipeline.
7071
The primary entry point for python development is `cryptkeeper.cryptkeeper()`, which has the following arguments:
7172

7273

@@ -88,7 +89,7 @@ rbs_score_cutoff : float, optional
8889
```
8990

9091

91-
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:
9293

9394

9495
* `name`: the name of the sample in the form of a `str`

0 commit comments

Comments
 (0)