mirror of
https://github.com/MillironX/SequenceVariation.jl.git
synced 2024-11-22 05:19:55 +00:00
Organize API docs
This commit is contained in:
parent
2a7d61e43d
commit
6f7110caec
1 changed files with 50 additions and 2 deletions
|
@ -7,6 +7,54 @@ end
|
|||
|
||||
# API Reference
|
||||
|
||||
```@autodocs
|
||||
Modules = [SequenceVariation]
|
||||
## Edits
|
||||
|
||||
```@docs
|
||||
Substitution
|
||||
Deletion
|
||||
Insertion
|
||||
```
|
||||
|
||||
## Variants
|
||||
|
||||
```@docs
|
||||
Variant
|
||||
reference(::Variant)
|
||||
variations
|
||||
reconstruct!
|
||||
```
|
||||
|
||||
## Variations
|
||||
|
||||
```@docs
|
||||
Variation
|
||||
reference(::Variation)
|
||||
mutation
|
||||
translate
|
||||
refbases
|
||||
altbases
|
||||
```
|
||||
|
||||
## Private API
|
||||
|
||||
### Edits
|
||||
|
||||
```@docs
|
||||
Edit
|
||||
_mutation
|
||||
_lendiff
|
||||
```
|
||||
|
||||
### Variants
|
||||
|
||||
```@docs
|
||||
_edits
|
||||
_is_valid(::Variant)
|
||||
```
|
||||
|
||||
### Variations
|
||||
|
||||
```@docs
|
||||
_edit
|
||||
_is_valid(::Variation)
|
||||
```
|
||||
|
|
Loading…
Reference in a new issue