Link all documentation in Planning Document

[luccalb]

User Story

1. As an RTDIP developer
2. I want to deliver high quality documentation
3. So that other developers can easily get familiar with the project and the usage

Additional context

Acceptance Criteria

• Links to all documentation resources are linked here: https://docs.google.com/spreadsheets/d/1aYT3oQxrqIutZrc2P0GwJNQteYgDYHYMqRohmdxubEM/edit?gid=1757988404#gid=1757988404 (AMOS Requirement!)
• This includes
  • Documentation generated from the code
  • Documentation we created as part of the homework (architecture diagrams etc.)
  • Documentation of RTDIP itself

Definition of Done

• Test cases have been created and are running successfully
• Documentation for the new component was added
• Github Actions are running without errors

[mollle]

The docu is now hosted under
https://amosproj.github.io/amos2024ws01-rtdip-data-quality-checker
To update:

1. delete the cname file
2. execute "mkdocs gh-deploy"
   After a few minutes the docu should be updated

[mollle]

Data Manipulation

• Z-Score Normalization
• Minmax Normalization
• Mean Normalization
• Denormalization
• Duplicate Detection Manipulation
• Interval Filtering
• Missing Value Imputation
• Dimensionality Reduction
• K-Sigma Anomaly Detection
• Out of Range Value Filter
• flatline filter
• Gaussian Smoothing not done yet

Data Monitoring

• Check Value Ranges
• Flatline Detection
• Identify Missing Data
• Moving Average

Forecasts

• ARMIA
• Auto ARIMA
• Linear Regression
• KNN Not done yet
• Data Binning