diff --git a/docs/_config.yml b/docs/_config.yml new file mode 100644 index 0000000..2f7efbe --- /dev/null +++ b/docs/_config.yml @@ -0,0 +1 @@ +theme: jekyll-theme-minimal \ No newline at end of file diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..0cbc22a --- /dev/null +++ b/docs/index.md @@ -0,0 +1,92 @@ +# Statistical Library V1.4 + +![GitHub release (latest by date)](https://img.shields.io/github/v/release/akkoyun/Statistical) ![arduino-library-badge](https://www.ardu-badge.com/badge/Statistical.svg?) ![Visits Badge](https://badges.pufler.dev/visits/akkoyun/Statistical) ![GitHub stars](https://img.shields.io/github/stars/akkoyun/Statistical?style=flat&logo=github) ![Updated Badge](https://badges.pufler.dev/updated/akkoyun/Statistical) ![PlatformIO Registry](https://badges.registry.platformio.org/packages/akkoyun/library/Statistical.svg) +[![Check Arduino](https://github.com/akkoyun/Statistical/actions/workflows/check-arduino.yml/badge.svg)](https://github.com/akkoyun/Statistical/actions/workflows/check-arduino.yml) [![Compile Examples](https://github.com/akkoyun/Statistical/actions/workflows/compile-examples.yml/badge.svg)](https://github.com/akkoyun/Statistical/actions/workflows/compile-examples.yml) [![Spell Check](https://github.com/akkoyun/Statistical/actions/workflows/spell-check.yml/badge.svg)](https://github.com/akkoyun/Statistical/actions/workflows/spell-check.yml) + + Build - 01.04.15 + +--- + +**Abstract** + + Descriptive statistics for Arduino float arrays + +We developed this library to help quickly accomplish median and mode filtering when collecting sensor data. Functions in this library operate on an array of float variables, of dimension "m", and return the corresponding statistic. This library was originally created for a data smoothing strategy for float variables. Using a median or mode filtering strategy (opposed to mean filtering) is better at removing spikes from aberrant readings. + +A bubble sort algorithm is also contained in this library which was necessary to calculate median and mode. + + +
+ Array Statistics + +
+Library calculate listed statistical parameters for fixed size arrays. + + * Sum + * Maximum + * Minimum + * Square Sum + * Arithmetic Average + * Geometric Average + * RMS Average + * 1 Sigma RMS Average + * Bubble Sort + * Median + * Standard Deviation + * Standard Deviation Error + * Coefficient Factor + * Array FILO + +
+ +
+ Stream Statistics + +
+Library calculate listed statistical parameters for data streams. + + * Data Count + * Arithmetic Average + * Minimum + * Maximum + +
+ +
+ Array Linear Regression + +
+Library calculate listed statistical parameters for fixed size arrays. + + * Slope + * Offset + * R2 + +
+ +
+ Stream Linear Regression + +
+Library calculate listed statistical parameters for data stream. User set the regression precision for calculating last n data regression. + + * Precision + * Slope + * Offset + * R2 + +
+ +
+ Machine Learning Algorithm + +
+This library will calculate slope of data according last n value. With these slope data system can learn sensor anomaly and make decision. + + + +
+ +--- + +[![Support me](https://img.shields.io/badge/Support-PATREON-GREEN.svg)](https://www.patreon.com/bePatron?u=62967889) ![Twitter Follow](https://img.shields.io/twitter/follow/gunceakkoyun?style=social) ![YouTube Channel Views](https://img.shields.io/youtube/channel/views/UCIguQGdaBT1GnnVMz5qAZ2Q?style=social) ![Repos Badge](https://badges.pufler.dev/repos/akkoyun) [![E-Mail](https://img.shields.io/badge/E_Mail-Mehmet_Gunce_Akkoyun-blue.svg)](mailto:akkoyun@me.com) ![GitHub](https://img.shields.io/github/license/akkoyun/Statistical) \ No newline at end of file diff --git a/examples/.DS_Store b/examples/.DS_Store index 1262835..87f0cd3 100644 Binary files a/examples/.DS_Store and b/examples/.DS_Store differ