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

[FIX, DOC] Change natural log to base-ten and document output naming convention #333

Merged
merged 4 commits into from
Sep 6, 2020

Conversation

tsalo
Copy link
Member

@tsalo tsalo commented Sep 6, 2020

Closes None, but references #133.

Changes proposed in this pull request:

  • Change natural logarithms in ALE and MKDA modules to base-ten logarithms to match NiMARE's broader convention.
  • Create docs/outputs.rst to document output naming convention.
  • Reorder items in documentation sidebar to better reflect their importance. Namely, the CLI is a useful item, but most users should use the Python functions directly, so the API should be at the top of the sidebar, and CLI should be at the bottom.

The order of the items in the sidebar should reflect the order of importance/relevance, to some extent.
The standard correctors are fine, but not the ALE and MKDA methods.
@tsalo tsalo changed the title [FIX] Change natural log to base10 log and document output naming convention [FIX, DOC] Change natural log to base10 log and document output naming convention Sep 6, 2020
@tsalo tsalo changed the title [FIX, DOC] Change natural log to base10 log and document output naming convention [FIX, DOC] Change natural log to base-ten and document output naming convention Sep 6, 2020
@codecov
Copy link

codecov bot commented Sep 6, 2020

Codecov Report

Merging #333 into master will not change coverage.
The diff coverage is 100.00%.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #333   +/-   ##
=======================================
  Coverage   82.17%   82.17%           
=======================================
  Files          37       37           
  Lines        3821     3821           
=======================================
  Hits         3140     3140           
  Misses        681      681           
Impacted Files Coverage Δ
nimare/meta/ale.py 95.95% <100.00%> (ø)
nimare/meta/mkda.py 96.10% <100.00%> (ø)

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 811e9b1...c74e953. Read the comment docs.

@tsalo tsalo merged commit 63c898c into neurostuff:master Sep 6, 2020
@tsalo tsalo deleted the fix/log branch September 6, 2020 16:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant