|
1 | 1 | # PlotRNA.jl |
2 | 2 |
|
3 | | -Plot nucleic acid secondary structures with Julia. The Julia |
4 | | -implementation currently only provides very basic |
5 | | -functionality. |
6 | | - |
7 | | -There is also an interface to the [VARNA](https://varna.lri.fr/) |
8 | | -package which offers a lot of advanced features, and an interface to |
9 | | -[R2R](https://zashaweinberglab.org/research/) for plotting multiple |
10 | | -sequence alignments with consensus structures. If you use the VARNA or |
11 | | -R2R interface in this package, please make sure to cite the |
12 | | -corresponding VARNA or R2R publication. |
13 | | - |
| 3 | +Plot nucleic acid secondary structures with Julia. |
| 4 | + |
| 5 | +There are currently four different backends: |
| 6 | + |
| 7 | +- `plot_structure`, `plot_structure_makie`: basic plotting implemented |
| 8 | + in Julia using `Luxor` or `CairoMakie` respectively |
| 9 | +- `PlotRNA.uniplot`: basic text-mode plotting in the terminal using |
| 10 | + `UnicodePlots` |
| 11 | +- `VARNA.plot`, `VARNA.plot_compare`: uses the |
| 12 | + [VARNA](https://varna.lri.fr/) package implemented in Java, offering |
| 13 | + advanced features |
| 14 | +- `R2R.plot`: uses [R2R](https://zashaweinberglab.org/research/) for |
| 15 | + plotting multiple sequence alignments with consensus structures |
| 16 | + |
| 17 | +If you use the VARNA or R2R interface in this package, please make |
| 18 | +sure to cite the corresponding VARNA or R2R publication. |
| 19 | + |
| 20 | +Note: to use `plot_structure_makie`, `CairoMakie` must be loaded |
| 21 | +before `PlotRNA`. To use `PlotRNA.uniplot`, `UnicodePlots` must be |
| 22 | +loaded before loading `PlotRNA`. This is to reduce the loading time of |
| 23 | +this package if these features are not used. See below for details. |
14 | 24 |
|
15 | 25 | ## Installation |
16 | 26 |
|
|
0 commit comments