// ---------------- [ File: tktax-stats/src/interpretation_notes.rs ]
crate::ix!();

pub fn write_summary_statistics_interpretation_notes() {
    const WRITE_SKEWNESS_NOTE: bool = true;
    const WRITE_KURTOSIS_NOTE: bool = true;

    const SKEWNESS_NOTE: &'static str = indoc!{
        "- Skewness (dimensionless) measures the asymmetry of the distribution.
            Skewness closer to zero indicates a symmetrical distribution. 
            Positive skewness suggests a long tail to the right (larger values). 
            Negative skewness indicates a long tail to the left (smaller values)."
    };
    const KURTOSIS_NOTE: &'static str = indoc!{
        "- Kurtosis (dimensionless) measures the \"tailedness\" of the distribution. 
            It is measured relative to the normal distribution.
            Higher kurtosis than normal is called \"leptokurtic\". 
            Leptokurtic suggests more data in the tails and a sharp peak. 
            Lower kurtosis than normal is called \"platykurtic\".
            Platykurtic indicates a flatter peak and thinner tails, implying less extreme outliers."
    };

    if WRITE_SKEWNESS_NOTE || WRITE_KURTOSIS_NOTE {
        println!("NOTES ON THE SUMMARY STATISTICS:");
    }

    if WRITE_SKEWNESS_NOTE { println!("{}\n", SKEWNESS_NOTE); }
    if WRITE_KURTOSIS_NOTE { println!("{}\n", KURTOSIS_NOTE); }
}
