Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
AntonOresten authored Jun 4, 2024
1 parent e01ef29 commit a41b924
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,10 @@ ProtPlot exports the Ribbon plot:

## Examples

A ribbon plot is constructed from a `Vector{Backboner.Protein.Chain}`, which you can obtain from a PDB file using the exported `readpdb` function. Alternatively, you can pass a single chain, or a PDB file path.
A ribbon plot is constructed from a `Vector{Backboner.Protein.Chain}`, which you can obtain from a PDB file using the exported `readpdb` function.
For convenience, argument conversion methods are defined, so you can also pass:
- a `3x3xL` array of residue backbone atom coordinates (N, Ca, C).
- a PDB file path.

```julia
using GLMakie # use the GLMakie backend
Expand Down

0 comments on commit a41b924

Please sign in to comment.