Skip to content

Commit

Permalink
Update BioMarkovChains documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
camilogarciabotero committed Nov 19, 2023
1 parent 3ed2876 commit 3b088e3
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 34 deletions.
33 changes: 0 additions & 33 deletions docs/src/biomarkovchains.md
Original file line number Diff line number Diff line change
Expand Up @@ -163,39 +163,6 @@ BioMarkovChain(sequence, 2)
- Markov Chain Order -> Int64:
2

## The *log-odds ratio* decision rule

The sequence probability given a transition probability model (eq. 2)
could be used as the source of a sequence classification based on a
decision rule to classify whether a sequence correspond to a model or
another. Now, imagine we got two DNA sequence transition models, a CDS
model and a No-CDS model. The *log-odds ratio* decision rule could be
establish as:

``` math
\begin{align}
S(X) = \log \frac{{P_C(X_1=i_1, \ldots, X_T=i_T)}}{{P_N(X_1=i_1, \ldots, X_T=i_T)}} \begin{cases} > \eta & \Rightarrow \text{coding} \\ < \eta & \Rightarrow \text{noncoding} \end{cases}
\end{align}
```

Where the ``P_{C}`` is the probability of the sequence given a
CDS model, ``P_{N}`` is the probability of the sequence given a
No-CDS model, the decision rule is finally based on whether the ratio is
greater or lesser than a given threshold *η* of significance level.

In the GeneFinder we have implemented this rule and a couple of basic
transition probability models of CDS and No-CDS of *E. coli* from
Axelson-Fisk (2015) work. To check whether a random sequence could be
coding based on these decision we use the predicate `iscoding` with the
`ECOLICDS` and `ECOLINOCDS` models:

``` julia
randseq = getorfdna(randdnaseq(99))[1] # this will retrieved a random coding ORF

iscoding(randseq, ECOLICDS, ECOLINOCDS)
```

true

## References

Expand Down
22 changes: 21 additions & 1 deletion docs/src/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# BioMarkovChains

```@raw html
<p align="center">
Expand All @@ -6,10 +8,28 @@
</p>
```

# BioMarkovChains
```@raw html
<div style="text-align: center;">
<a href="https://camilogarciabotero.github.io/BioMarkovChains.jl/dev/"><img src="https://img.shields.io/badge/documentation-online-blue.svg?logo=Julia&logoColor=white" alt="Documentation"></a>
<a href="https://github.com/camilogarciabotero/BioMarkovChains.jl/releases/latest"><img src="https://img.shields.io/github/release/camilogarciabotero/BioMarkovChains.jl.svg" alt="Latest Release"></a>
<a href="https://zenodo.org/badge/latestdoi/665161607"><img src="https://zenodo.org/badge/665161607.svg" alt="DOI"></a>
<br/>
<a href="https://github.com/camilogarciabotero/BioMarkovChains.jl/actions/workflows/CI.yml"><img src="https://github.com/camilogarciabotero/BioMarkovChains.jl/actions/workflows/CI.yml/badge.svg" alt="CI Workflow"></a>
<a href="https://github.com/camilogarciabotero/BioMarkovChains.jl/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-green.svg" alt="License"></a>
<a href="https://www.repostatus.org/#wip"><img src="https://www.repostatus.org/badges/latest/wip.svg" alt="Work in Progress"></a>
<a href="https://pkgs.genieframework.com?packages=BioMarkovChains"><img src="https://shields.io/endpoint?url=https://pkgs.genieframework.com/api/v1/badge/BioMarkovChains&label=downloads" alt="Downloads"></a>
</div>
```


Documentation for [BioMarkovChains](https://github.com/camilogarciabotero/BioMarkovChains.jl).



***
## Overview

Expand Down

0 comments on commit 3b088e3

Please sign in to comment.