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
|
2023-01-05 18:32:54 +00:00
|
|
|
reconstruct
|
2023-01-05 19:10:24 +00:00
|
|
|
translate(::Haplotype{S,T}, ::PairwiseAlignment{S,S}) where {S,T}
|
2022-12-31 21:15:44 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
## Variations
|
|
|
|
|
|
|
|
```@docs
|
|
|
|
Variation
|
|
|
|
reference(::Variation)
|
|
|
|
mutation
|
2023-01-05 19:10:24 +00:00
|
|
|
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
|
|
|
```
|