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

documentation: definition of significance seems to be wrong #23

Open
fookatchu opened this issue Nov 27, 2020 · 4 comments
Open

documentation: definition of significance seems to be wrong #23

fookatchu opened this issue Nov 27, 2020 · 4 comments

Comments

@fookatchu
Copy link

fookatchu commented Nov 27, 2020

The definition of "significance" seems to be wrong. According to the docs:

“s” or “significance”: the sensitivity coefficient (below) multiplied by the standard uncertainty, displayed by default

The significance is in fact calculated as x.u / result.u (or v[0]/yu in budget.py)

If I am not mistaken, the correct text should therefore be:

“s” or “significance”: the sensitivity coefficient (below) multiplied by the standard uncertainty divided by the combined standard uncertainty, displayed by default

@fookatchu
Copy link
Author

This also raises the question on how to retreive the uncertainty contribution sensitivity coefficient * standard uncertainty. Maybe I am just overlooking something?

@hvparks
Copy link
Collaborator

hvparks commented Jul 5, 2021

You are correct, the significance is sensitivity coefficient * standard uncertainty/combined uncertainty.

I will add a column for sensitivity coefficient * standard uncertainty

@hvparks
Copy link
Collaborator

hvparks commented Jul 11, 2021

The documentation has been fixed, though I still need to add the column for sensitivity coefficient * standard uncertainty.

@Naikless
Copy link

The documentation is still wrong here. Moreover, wouldn't it make more sense to define s as (sensitivity coefficient * standard uncertainty/combined uncertainty)**2 so they all add up to one?

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

No branches or pull requests

3 participants