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

Understanding the implementation of the StrandOddsRatio #5700

Closed
nh13 opened this issue Feb 21, 2019 · 4 comments
Closed

Understanding the implementation of the StrandOddsRatio #5700

nh13 opened this issue Feb 21, 2019 · 4 comments
Assignees

Comments

@nh13
Copy link
Contributor

nh13 commented Feb 21, 2019

I am trying to understand the calculation of the StrandOddsRatio. The online documentation and javadoc for the StrandOddsRatio class shows it as:

$$ refRatio = \frac{max(X[0][0], X[0][1])}{min(X[0][0], X[0][1} $$

Nonetheless, my reading of the code shows it as

$$ refRatio = \frac{min(X[0][0], X[0][1])}{max(X[0][0], X[0][1} $$

The code is:

final double refRatio = min(t00, t01)/ max(t00, t01);

The docs say its max/min while the code does min/max. The same is true for the docs and implementation of altRatio. It looks like either a bug, or the docs need to be updated.

@nh13
Copy link
Contributor Author

nh13 commented Feb 21, 2019

Related to #5698

@ldgauthier
Copy link
Contributor

That might have been me. I'm a little dyslexic.

@nh13
Copy link
Contributor Author

nh13 commented Feb 21, 2019

No worries.

@sooheelee
Copy link
Contributor

@nh13, the next release should reflect SOR documentation updates from #5703.

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