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 more details to the dev docs and update README #68

Closed taylorreiter closed 1 year ago

taylorreiter commented 1 year ago

This PR updates the developer documentation and the README. I think it's the last PR (🤞) before linking to zenodo, cutting the first release (v. 0.1.0 🎉) and getting a DOI, so please mention anything else that sticks out that you think needs to be done before hand!

*Note the DOI and link to the pub won't resolve until the pub is released, but I want them to be recorded in zenodo so I'm using them as placeholders as they are accurate.

codecov-commenter commented 1 year ago

Codecov Report

Base: 92.02% // Head: 92.02% // No change to project coverage :thumbsup:

Coverage data is based on head (204eda3) compared to base (3cf1ade). Patch has no changes to coverable lines.

:mega: This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #68 +/- ## ======================================= Coverage 92.02% 92.02% ======================================= Files 8 8 Lines 627 627 ======================================= Hits 577 577 Misses 50 50 ``` 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.