motleystate / moonstone

Library to perform Metagenomics data analysis with Python
https://moonstone.readthedocs.io/en/latest/?badge=latest
MIT License
1 stars 0 forks source link

Update documentation #1 #88

Closed AgnesBaud closed 2 years ago

AgnesBaud commented 2 years ago

Description

Update moonstone's diversity (and other) documentation + Creation of a jupyter notebook Tutorial

Definition of Done

codecov-commenter commented 2 years ago

Codecov Report

Merging #88 (ee6cd36) into master (ed14b68) will increase coverage by 0.14%. The diff coverage is 92.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master      #88      +/-   ##
==========================================
+ Coverage   64.28%   64.43%   +0.14%     
==========================================
  Files          60       60              
  Lines        2831     2837       +6     
==========================================
+ Hits         1820     1828       +8     
+ Misses       1011     1009       -2     
Flag Coverage Δ
unittests 64.43% <92.00%> (+0.14%) :arrow_up:

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

Impacted Files Coverage Δ
moonstone/utils/dict_operations.py 100.00% <ø> (ø)
moonstone/analysis/diversity/alpha.py 96.22% <83.33%> (-1.74%) :arrow_down:
moonstone/analysis/diversity/base.py 81.56% <92.85%> (+0.20%) :arrow_up:
moonstone/analysis/diversity/beta.py 79.81% <100.00%> (ø)
moonstone/core/module_base.py 78.57% <0.00%> (+10.71%) :arrow_up:

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 ed14b68...ee6cd36. Read the comment docs.