Update API documentation for different `translate` methods

master
parent 6a4a39c859
commit ecaa995d2b

@ -22,6 +22,7 @@ Haplotype
reference(::Haplotype)
variations
reconstruct
translate(::Haplotype{S,T}, ::PairwiseAlignment{S,S}) where {S,T}
```
## Variations
@ -30,7 +31,7 @@ reconstruct
Variation
reference(::Variation)
mutation
translate
translate(::Variation{S,T}, ::PairwiseAlignment{S,S}) where {S,T}
refbases
altbases
```

@ -54,13 +54,15 @@ variations(bos_human_haplotype)
## Reference switching
An individual variation can be mapped to a new reference sequence given an
alignment between the new and old references using the [`translate`](@ref).
alignment between the new and old references using the
[`translate`](@ref translate(::Variation{S,T}, ::PairwiseAlignment{S,S}) where {S,T})
function.
```@repl call_variants
ovis_human_alignment =
PairwiseAlignment(AlignedSequence(human, Alignment("32M", 1, 1)), ovine)
human_variation = first(variations(bos_ovis_haplotype))
reference(ans) == bovine
SequenceVariation.translate(human_variation, ovis_human_haplotype)
SequenceVariation.translate(human_variation, ovis_human_alignment)
reference(ans) == bovine
```

Loading…
Cancel
Save