Arcadia-Science / sourmashconsumr

Working with the outputs of sourmash in R
https://arcadia-science.github.io/sourmashconsumr/
Other
21 stars 3 forks source link

Add a readme #44

Closed taylorreiter closed 1 year ago

taylorreiter commented 1 year ago

I looked at these three READMEs for inspiration:

I might eventually remove the function list from the Usage section, especially after I've actually written a vignette. I get nervous that it will get out of date. But I kind of like it there for now until I have finished writing documentation.

codecov-commenter commented 1 year ago

Codecov Report

Base: 87.09% // Head: 91.41% // Increases project coverage by +4.31% :tada:

Coverage data is based on head (7c81433) compared to base (c330974). Patch coverage: 93.67% of modified lines in pull request are covered.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #44 +/- ## ========================================== + Coverage 87.09% 91.41% +4.31% ========================================== Files 7 8 +1 Lines 403 524 +121 ========================================== + Hits 351 479 +128 + Misses 52 45 -7 ``` | [Impacted Files](https://codecov.io/gh/Arcadia-Science/sourmashconsumr/pull/44?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Arcadia-Science) | Coverage Δ | | |---|---|---| | [R/plot\_taxonomy\_annotate.R](https://codecov.io/gh/Arcadia-Science/sourmashconsumr/pull/44/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Arcadia-Science#diff-Ui9wbG90X3RheG9ub215X2Fubm90YXRlLlI=) | `93.00% <91.26%> (+16.38%)` | :arrow_up: | | [R/plot\_gather.R](https://codecov.io/gh/Arcadia-Science/sourmashconsumr/pull/44/diff?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Arcadia-Science#diff-Ui9wbG90X2dhdGhlci5S) | `98.18% <98.18%> (ø)` | | Help us with your feedback. Take ten seconds to tell us [how you rate us](https://about.codecov.io/nps?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Arcadia-Science). Have a feature suggestion? [Share it here.](https://app.codecov.io/gh/feedback/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Arcadia-Science)

:umbrella: View full report at Codecov.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.