From 2004d3095117cc732d5c12a4a382b39242ecda6a Mon Sep 17 00:00:00 2001 From: Christoph Ruegg Date: Sun, 11 Feb 2018 10:33:53 +0100 Subject: [PATCH] GoodnessOfFit: try to clarify documentation --- src/Numerics/GoodnessOfFit.cs | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/src/Numerics/GoodnessOfFit.cs b/src/Numerics/GoodnessOfFit.cs index 29ad6cca..11cc3db3 100644 --- a/src/Numerics/GoodnessOfFit.cs +++ b/src/Numerics/GoodnessOfFit.cs @@ -37,11 +37,12 @@ namespace MathNet.Numerics public static class GoodnessOfFit { /// - /// Calculates the R-Squared value, also known as coefficient of determination, - /// given modelled and observed values + /// Calculates r^2, the square of the sample correlation coefficient between + /// the observed outcomes and the observed predictor values. + /// Not to be confused with R^2, the coefficient of determination, see . /// - /// The values expected from the modelled - /// The actual data set values obtained + /// The modelled/predicted values + /// The observed/actual values /// Squared Person product-momentum correlation coefficient. public static double RSquared(IEnumerable modelledValues, IEnumerable observedValues) { @@ -50,11 +51,11 @@ namespace MathNet.Numerics } /// - /// Calculates the R value, also known as linear correlation coefficient, - /// given modelled and observed values + /// Calculates r, the sample correlation coefficient between the observed outcomes + /// and the observed predictor values. /// - /// The values expected from the modelled - /// The actual data set values obtained + /// The modelled/predicted values + /// The observed/actual values /// Person product-momentum correlation coefficient. public static double R(IEnumerable modelledValues, IEnumerable observedValues) {