search

meyer-lab / tHMM

A general Python framework for using hidden Markov models on binary trees or cell lineage trees.
https://asmlab.org
MIT License
10 stars 1 forks source link

docs added and updated #853

Closed Farnazmdi closed 3 years ago

Farnazmdi commented 3 years ago

This PR has two files in the Docs folder, 1.overview.rst and 2.stateDistribution.rst which I think they include enough information about getting started and using the package. The problem is that mathematical expressions are not shown in mathematical expressions! Is is alright or we want to be sure that they show up in math? In a half-an-hour search, I couldn't find another way of showing math expression in .rst files. It seems it is a challenge for a lot of people...

codecov[bot] commented 3 years ago

Codecov Report

Merging #853 (91c0801) into master (655f2f7) will not change coverage. The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #853   +/-   ##
=======================================
  Coverage   74.00%   74.00%           
=======================================
  Files          24       24           
  Lines        1900     1900           
=======================================
  Hits         1406     1406           
  Misses        494      494
Flag Coverage Δ
unittests 74.00% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 655f2f7...91c0801. Read the comment docs.

Farnazmdi commented 3 years ago

They do build now, A part of the overview looks like this: image

aarmey commented 3 years ago

Excellent!