Skip to content
Snippets Groups Projects
Commit 89d5cb56 authored by David Schäfer's avatar David Schäfer
Browse files

renamed file FunctionDescriptions

parent 19799069
No related branches found
No related tags found
No related merge requests found
......@@ -43,7 +43,7 @@ quality control and/or modify them.
![Example config](docs/images/screenshot_config.png "Example config")
While a good (but still growing) number of predefined and highly configurable
[functions](docs/FunctionDescriptions.md) are included and ready to use, SaQC
[functions](docs/FunctionIndex.md) are included and ready to use, SaQC
additionally ships with a python based
[extension language](docs/GenericFunctions.md).
......
# Customizations
SaQC comes with a continuously growing number of pre-implemented
[quality check and processing routines](docs/FunctionDescriptions.md) and
[quality check and processing routines](docs/FunctionIndex.md) and
flagging schemes.
For any sufficiently large use case however, chances are high, that the
functions provided won't fulfill all your needs and requirements.
......
# Implemented Quality Check Functions
Index of the main documentation of the implemented functions, their purpose and parametrization.
## Index
- [Miscellaneous](docs/funcs/Miscellaneous.md)
- [range](docs/funcs/Miscellaneous.md#range)
- [seasonalRange](docs/funcs/Miscellaneous.md#seasonalrange)
- [isolated](docs/funcs/Miscellaneous.md#isolated)
- [missing](docs/funcs/Miscellaneous.md#missing)
- [clear](docs/funcs/Miscellaneous.md#clear)
- [force](docs/funcs/Miscellaneous.md#force)
- [Spike Detection](docs/funcs/SpikeDetection.md)
- [spikes_basic](docs/funcs/SpikeDetection.md#spikes_basic)
- [spikes_simpleMad](docs/funcs/SpikeDetection.md#spikes_simplemad)
- [spikes_slidingZscore](docs/funcs/SpikeDetection.md#spikes_slidingzscore)
- [spikes_spektrumBased](docs/funcs/SpikeDetection.md#spikes_spektrumbased)
- [Constant Detection](docs/funcs/ConstantDetection.md)
- [constant](docs/funcs/ConstantDetection.md#constant)
- [constants_varianceBased](docs/funcs/ConstantDetection.md#constants_variancebased)
- [Break Detection](docs/funcs/BreakDetection.md)
- [breaks_spektrumBased](docs/funcs/BreakDetection.md#breaks_spektrumbased)
- [Time Series Harmonization](docs/funcs/TimeSeriesHarmonization.md)
- [harmonize_shift2Grid](docs/funcs/TimeSeriesHarmonization.md#harmonize_shift2grid)
- [harmonize_aggregate2Grid](docs/funcs/TimeSeriesHarmonization.md#harmonize_aggregate2grid)
- [harmonize_linear2Grid](docs/funcs/TimeSeriesHarmonization.md#harmonize_linear2grid)
- [harmonize_interpolate2Grid](docs/funcs/TimeSeriesHarmonization.md#harmonize_interpolate2grid)
- [harmonize_downsample](docs/funcs/TimeSeriesHarmonization.md#harmonize_downsample)
- [harmonize](docs/funcs/TimeSeriesHarmonization.md#harmonize)
- [deharmonize](docs/funcs/TimeSeriesHarmonization.md#deharmonize)
- [Soil Moisture](docs/funcs/SoilMoisture.md)
- [soilMoisture_spikes](docs/funcs/SoilMoisture.md#soilmoisture_spikes)
- [soilMoisture_breaks](docs/funcs/SoilMoisture.md#soilmoisture_breaks)
- [soilMoisture_plateaus](docs/funcs/SoilMoisture.md#soilmoisture_plateaus)
- [soilMoisture_byFrost](docs/funcs/SoilMoisture.md#soilmoisture_byfrost)
- [soilMoisture_byPrecipitation](#soilmoisture_byprecipitation)
- [Machine Learning](docs/funcs/MachineLearning.md)
- [machinelearning](docs/funcs/MachineLearning.md#machinelearning)
......@@ -14,7 +14,7 @@ challenging to translate them into general purpose source code.
## Specification
Generic functions are used in the same manner as their
[non-generic counterparts](docs/FunctionDescriptions.md). The basic
[non-generic counterparts](docs/FunctionIndex.md). The basic
signature looks like that:
```sh
flagGeneric(func=<expression>, flag=<flagging_constant>)
......
......@@ -91,7 +91,7 @@ different variables by following the pattern:
In this case, we define a range-test that flags all values outside the range
[10,60] and a test to detect spikes using the MAD-method. You can find an
overview of all available quality control tests in the
[documentation](FunctionDescriptions.md). Note that the tests are
[documentation](FunctionIndex.md). Note that the tests are
_executed in the order that you define in the configuration file_. The quality
flags that are set during one test are always passed on to the subsequent one.
......@@ -183,7 +183,7 @@ series. Also, you can write your own tests using a python-based
The above executes an internal framework that harmonizes the timestamps of SM2
to a 15min-grid (see data below). Further information about this routine can be
found in the [function definition](docs/FunctionDescriptions.md).
found in the [function definition](docs/FunctionIndex.md).
Date,SM1,SM1_flags,SM2,SM2_flags
2016-04-01 00:00:00,,,29.3157,OK
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment