Skip to content

Commit

Permalink
extension import docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jgreener64 committed Aug 28, 2024
1 parent 3ae898d commit 6fe842f
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions docs/src/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ CurrentModule = BioStructures

Package extensions are used in order to reduce the number of dependencies:
- To use `LongAA`, call `using BioSequences`.
- To use `pairalign`, [`superimpose!`](@ref), [`rmsd`](@ref)/[`displacements`](@ref) with the `superimpose` option or [`Transformation`](@ref) on structural elements, call `using BioSequences, BioAlignments`.
- To use `pairalign`, [`superimpose!`](@ref), [`rmsd`](@ref)/[`displacements`](@ref) with the `superimpose` option or [`Transformation`](@ref) on structural elements, call `using BioAlignments`.
- To use `DataFrame`, call `using DataFrames`.
- To use `MetaGraph`, call `using Graphs, MetaGraphs`.
- To use `MetaGraph`, call `using MetaGraphs`.
- To use [`MMTFDict`](@ref) or [`writemmtf`](@ref), call `import MMTF`.
- To use [`rundssp!`](@ref), [`rundssp`](@ref) or the `run_dssp` option with `read`/[`retrievepdb`](@ref), call `using DSSP_jll`.
- To use [`runstride!`](@ref), [`runstride`](@ref) or the `run_stride` option with `read`/[`retrievepdb`](@ref), call `using STRIDE_jll`.
Expand Down
4 changes: 2 additions & 2 deletions docs/src/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -424,7 +424,7 @@ Various functions are provided to calculate spatial quantities for proteins:
| [`superimpose!`](@ref) | Superimpose one element onto another |
| [`rmsd`](@ref) | RMSD between two elements, with or without superimposition |
| [`displacements`](@ref) | `Vector` of displacements between two elements, with or without superimposition |
| `MetaGraph` | Construct a `MetaGraph` of contacting elements (call `using Graphs, MetaGraphs` first) |
| `MetaGraph` | Construct a `MetaGraph` of contacting elements (call `using MetaGraphs` first) |

The [`omegaangle`](@ref), [`phiangle`](@ref) and [`psiangle`](@ref) functions can take either a pair of residues or a chain and a position.
The [`omegaangle`](@ref) and [`phiangle`](@ref) functions measure the angle between the residue at the given index and the one before.
Expand Down Expand Up @@ -483,7 +483,7 @@ To carry out superimposition, BioStructures.jl carries out a sequence alignment
For example:

```julia
using BioSequences, BioAlignments
using BioAlignments

# Change the coordinates of element 1 to superimpose it onto element 2
# Do sequence alignment with standard residues and calculate the transformation with Cα atoms (the default)
Expand Down

0 comments on commit 6fe842f

Please sign in to comment.