Skip to content

Commit 59a29dc

Browse files
committed
Improve package description in README
1 parent e2c6c3a commit 59a29dc

File tree

1 file changed

+21
-11
lines changed

1 file changed

+21
-11
lines changed

README.md

Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,26 @@
11
# PlotRNA.jl
22

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

1525
## Installation
1626

0 commit comments

Comments
 (0)