Skip to content

Commit

Permalink
Merge branch 'main' of https://github.com/MurrellGroup/ProtPlot.jl
Browse files Browse the repository at this point in the history
  • Loading branch information
@AntonOresten
AntonOresten committed Sep 25, 2024
2 parents b12f8c7 + 1c4acb0 commit ff7e1aa
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +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.
For convenience, argument conversion methods are defined, so you can also pass:
Ribbon plots are constructed from vectors of protein backbones represented as `3x3xL` arrays.
For convenience, argument conversion methods are defined, and the ribbon constructors can take:
- a `3x3xL` array of residue backbone atom coordinates (N, Ca, C), or a vector of these for each chain.
- a `PDBEntry(pdb_id)`, which will download a temporary file, read it, delete it, and return a vector of chains.
- a `BioStructures.MolecularStructure` or `BioStructures.Chain`.
- a PDB file path.

```julia
Expand Down

2 comments on commit ff7e1aa

@AntonOresten
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator register

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/116089

Tip: Release Notes

Did you know you can add release notes too? Just add markdown formatted text underneath the comment after the text
"Release notes:" and it will be added to the registry PR, and if TagBot is installed it will also be added to the
release that TagBot creates. i.e.

@JuliaRegistrator register

Release notes:

## Breaking changes

- blah

To add them here just re-invoke and the PR will be updated.

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.5.2 -m "<description of version>" ff7e1aac13b5ef95c0bf71d9593af0048c430080
git push origin v0.5.2

Please sign in to comment.