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

Add possibility to return standard deviations for example models. #361

Merged
merged 12 commits into from Jun 10, 2020

Conversation

timmens
Copy link
Member

@timmens timmens commented Jun 6, 2020

Current behavior

Currently when asking for the params of an example model via rp.get_example_model, for example with model="kw_97_basis", only the mean estimates of the model are returned and not the estimated standard deviations.

Desired behavior

An option which enables the return of the standard deviations in a bigger params data frame which has a third level on the multiindex for "mean", the classical params data frame, and "sd" the values for the standard deviations.

Solution / Implementation

See above.

Todo

  • Review whether the documentation needs to be updated.
  • Document PR in CHANGES.rst.

@timmens timmens changed the title Example model sd timmens Add possibility to return standard deviations for example models. Jun 6, 2020
@codecov
Copy link

codecov bot commented Jun 6, 2020

Codecov Report

Merging #361 into master will decrease coverage by 0.03%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #361      +/-   ##
==========================================
- Coverage   84.74%   84.71%   -0.04%     
==========================================
  Files          45       45              
  Lines        2957     2957              
==========================================
- Hits         2506     2505       -1     
- Misses        451      452       +1     
Flag Coverage Δ
#end_to_end_edge_case 65.53% <ø> (-0.21%) ⬇️
#end_to_end_precise 52.41% <ø> (-1.05%) ⬇️
#end_to_end_rest 73.21% <ø> (ø)
#integration_edge_case 43.11% <ø> (ø)
#integration_precise 46.09% <ø> (ø)
#integration_rest 64.82% <ø> (ø)
#unit_precise 70.64% <ø> (-0.75%) ⬇️
#unit_rest 25.29% <ø> (ø)
Impacted Files Coverage Δ
respy/solve.py 98.48% <0.00%> (-1.52%) ⬇️

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 303aef6...4ce9c36. Read the comment docs.

@timmens
Copy link
Member Author

timmens commented Jun 7, 2020

Hello @tobiasraabe, do these changes work for you. I have a feeling that the get_example_model function is a little bloat, but I couldn't think of a more succinct way of adding this feature.

Copy link
Member

@tobiasraabe tobiasraabe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi Tim, thanks for this PR! It is perfect and thanks for finding the two mistakes in the former parameterization ❤️. Just one last thing. Please add this PR and your name to the release notes. Then, feel free to merge!

@tobiasraabe
Copy link
Member

tobiasraabe commented Jun 10, 2020

When you merge, please, remove the commit message in the body of the merge comment. It is useless and clutters git log.

@tobiasraabe tobiasraabe added this to the 2.0.0 milestone Jun 10, 2020
@timmens timmens requested a review from amageh as a code owner June 10, 2020 16:45
@timmens timmens merged commit 4813ed8 into master Jun 10, 2020
@timmens timmens deleted the example_model_sd_timmens branch June 10, 2020 17:34
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.

None yet

2 participants