From 2e8626e4360d8125862f9b8e7005c60e58b763d2 Mon Sep 17 00:00:00 2001 From: Johannes Keyser <johannes.keyser@sport.uni-giessen.de> Date: Tue, 22 Mar 2022 19:23:25 +0100 Subject: [PATCH] Add some explanation about the example. --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7fe1e99..42792ba 100644 --- a/README.md +++ b/README.md @@ -29,9 +29,11 @@ TODO: Add examples, and show some expected output. ### Example -You can see an example in [example.m](example.m). +The script [example.m](example.m) simulates data based on known, true values. +It then fits and compares the Least-Squares with the Theil-Sen estimator. +Note how a few "unlucky" outliers can bias the least-squares estimate, but have little effect on the Theil-Sen estimator. -<img src="example.svg" alt="plot from example.m" width=200px /> +<img src="example.svg" alt="plot from example.m" width=500px /> ## Roadmap -- GitLab