SequenceVariation.jl/docs/src/api.md

62 lines
659 B
Markdown
Raw Normal View History

2022-07-05 15:34:21 +00:00
```@meta
CurrentModule = SequenceVariation
DocTestSetup = quote
using SequenceVariation
end
```
# API Reference
2022-12-31 21:15:44 +00:00
## Edits
```@docs
Substitution
Deletion
Insertion
```
## Variants
```@docs
2023-01-04 18:45:25 +00:00
Haplotype
reference(::Haplotype)
2022-12-31 21:15:44 +00:00
variations
reconstruct
translate(::Haplotype{S,T}, ::PairwiseAlignment{S,S}) where {S,T}
2022-12-31 21:15:44 +00:00
```
## Variations
```@docs
Variation
reference(::Variation)
mutation
translate(::Variation{S,T}, ::PairwiseAlignment{S,S}) where {S,T}
2022-12-31 21:15:44 +00:00
refbases
altbases
```
## Private API
### Edits
```@docs
Edit
_mutation
_lendiff
```
### Variants
```@docs
_edits
2023-01-04 18:45:25 +00:00
_is_valid(::Haplotype)
2022-12-31 21:15:44 +00:00
```
### Variations
```@docs
_edit
_is_valid(::Variation)
2022-07-05 15:34:21 +00:00
```