search

datactive / bigbang

Scientific analysis of collaborative communities
http://datactive.github.io/bigbang/
MIT License
148 stars 52 forks source link

Tutorial and readme #589

Closed micahflee closed 1 year ago

micahflee commented 1 year ago

I went through the entire tutorial, edit it, and made sure all of the Python scripts ran successfully.

I also took a bunch of the project's background info from the tutorial and moved it to the readme.

This PR is based off of #585.

codecov-commenter commented 1 year ago

Codecov Report

Patch coverage: 46.47% and project coverage change: -0.53 :warning:

Comparison is base (9d4eed6) 73.73% compared to head (b5a0cca) 73.20%.

: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 #589 +/- ## ========================================== - Coverage 73.73% 73.20% -0.53% ========================================== Files 30 31 +1 Lines 3632 3702 +70 ========================================== + Hits 2678 2710 +32 - Misses 954 992 +38 ``` | Flag | Coverage Δ | | |---|---|---| | unittests | `73.20% <46.47%> (-0.53%)` | :arrow_down: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=datactive#carryforward-flags-in-the-pull-request-comment) to find out more. | [Impacted Files](https://codecov.io/gh/datactive/bigbang/pull/589?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=datactive) | Coverage Δ | | |---|---|---| | [bigbang/archive.py](https://codecov.io/gh/datactive/bigbang/pull/589?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=datactive#diff-YmlnYmFuZy9hcmNoaXZlLnB5) | `70.27% <ø> (ø)` | | | [bigbang/cli.py](https://codecov.io/gh/datactive/bigbang/pull/589?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=datactive#diff-YmlnYmFuZy9jbGkucHk=) | `44.92% <44.92%> (ø)` | | | [bigbang/\_\_init\_\_.py](https://codecov.io/gh/datactive/bigbang/pull/589?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=datactive#diff-YmlnYmFuZy9fX2luaXRfXy5weQ==) | `100.00% <100.00%> (ø)` | | | [bigbang/config.py](https://codecov.io/gh/datactive/bigbang/pull/589?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=datactive#diff-YmlnYmFuZy9jb25maWcucHk=) | `100.00% <100.00%> (ø)` | | 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=datactive). 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=datactive)

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

sbenthall commented 1 year ago

Thanks for the super helpful revisions! Merging.