API Reference

API Reference

This is a guide to public-facing API (Application Programming Interface) of FSML!

Structure

The FSML procedures are categorised into several thematic modules:

  • STS: Basic (sample) statistics (e.g., mean, variance)
  • DST: Statistical distributions (e.g., Student's t distribution) probability density function (PDF), cumulative distribution function (CDF), and percent point function (PPF)
  • TST: Statistical hypothesis testing (e.g., ANOVA)
  • LIN: Statistical procedures relying heavily on linear algebra (e.g., PCA, OLS regression)
  • NLP: Nonlinear and algorithmic procedures (e.g., k-means clustering)

While the public interfaces do not include these as prefixes, the handbook makes use of these categories to give it more structure. If you are interested in exploring the code, you will recognise these in module and procedure names.

Coverage

The following procedures are currently covered and have a public-facing interface. The links will take you directly to the documentation for the API.

Sample Statistics (STS) Distributions (DST) Tests (TST)
Mean Normal PDF Student t-test (1 sample)
Variance Normal CDF Paired sample t-test
Standard deviation Normal PPF Pooled t-test (2 sample)
Covariance Student's t PDF Welch's t-test (2 sample)
Linear trend Student's t CDF Analysis of variance (one way)
Correlation (Pearson) Student's t PPF Wilcoxon signed-rank (1 sample)
Gamma PDF Wilcoxon signed-rank (paired)
Gamma CDF Mann–Whitney U rank-sum (2 sample)
Gamma PPF Kruskall Wallis H test
Exponential PDF
Exponential CDF
Exponential PPF
Chi-squared PDF
Chi-squared CDF
Chi-squared PPF
F PDF
F CDF
F PPF
Generalised Pareto PDF
Generalised Pareto CDF
Generalised Pareto PPF