search

miykael / atlasreader

Python interface for generating coordinate tables and region labels from statistical MRI images
BSD 3-Clause "New" or "Revised" License
89 stars 31 forks source link

Update README and notebook #89

Closed miykael closed 5 years ago

miykael commented 5 years ago

The main contribution of this PR is the update of the README and the example notebook. I've added more content to both documents to prepare them for the publication.

Additionally, I found some small bugs or typos in the source code, which I corrected with https://github.com/miykael/atlasreader/commit/b33da161da62b661abf131cd0fc3cfaeda9d529d, https://github.com/miykael/atlasreader/commit/c6281a89f72d85f74292cb733795a118e149f129, https://github.com/miykael/atlasreader/commit/78c4e1458b164e9b1e2a18fbabc32f40a80e5fd5.

codecov-io commented 5 years ago

Codecov Report

Merging #89 into master will increase coverage by 0.06%. The diff coverage is 100%.

Impacted file tree graph

@@           Coverage Diff           @@
##           master   #89      +/-   ##
=======================================
+ Coverage   87.93%   88%   +0.06%     
=======================================
  Files           6     6              
  Lines         398   400       +2     
=======================================
+ Hits          350   352       +2     
  Misses         48    48
Impacted Files Coverage Δ
atlasreader/cli.py 0% <ø> (ø) :arrow_up:
atlasreader/atlasreader.py 96.03% <100%> (+0.03%) :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 283b5a5...e595ee7. Read the comment docs.

miykael commented 5 years ago

The changes in this PR are mostly concerning the documentation. I will merge this already to have a first draft for how the final package should look like. Later correction can be submitted to the "paper PR" (https://github.com/miykael/atlasreader/pull/66).