Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update the docs #236

Draft
wants to merge 37 commits into
base: main
Choose a base branch
from
Draft

Update the docs #236

wants to merge 37 commits into from

Conversation

robomics
Copy link
Contributor

Closes #213.

@robomics robomics added the documentation Improvements or additions to documentation label Aug 27, 2024
Copy link

codecov bot commented Aug 28, 2024

Codecov Report

Attention: Patch coverage is 86.66667% with 2 lines in your changes missing coverage. Please review.

Project coverage is 71.93%. Comparing base (7df9f84) to head (0c76328).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
src/hictk/cli/cli_rename_chromosomes.cpp 80.00% 1 Missing ⚠️
src/hictk/validate/validate.cpp 80.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #236      +/-   ##
==========================================
- Coverage   71.94%   71.93%   -0.01%     
==========================================
  Files         167      167              
  Lines       13569    13568       -1     
  Branches     1550     1550              
==========================================
- Hits         9762     9760       -2     
- Misses       2513     2514       +1     
  Partials     1294     1294              
Flag Coverage Δ
[tests integration](https://app.codecov.io/gh/paulsengroup/hictk/pull/236/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=paulsengroup) 62.36% <92.85%> (-0.01%)
[tests unittests](https://app.codecov.io/gh/paulsengroup/hictk/pull/236/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=paulsengroup) 51.42% <0.00%> (-0.01%)

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@robomics
Copy link
Contributor Author

Double-check API docs.

@robomics
Copy link
Contributor Author

TODO: mention compression formats supported by hitck load

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[docs] improve docs for hictk metadata
1 participant