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

Update README.md

parent ffccc098
No related branches found
No related tags found
No related merge requests found
...@@ -31,19 +31,20 @@ ...@@ -31,19 +31,20 @@
+ Number + Number
+ if a value is flagged, so are the next n previously unflagged values + if a value is flagged, so are the next n previously unflagged values
### Predifined Test ### Predifined Tests
| name | required parameters | optional parameters | description |
|-------|---------------------|---------------------|---------------------------| | name | required parameters | optional parameters | description |
| `mad` | `z`, `length` | `deriv = 1` | mean absolute deviation | |-------|---------------------|---------------------|---------------------------|
| | | | with measure of central | | `mad` | `z`, `length` | `deriv = 1` | mean absolute deviation |
| | | | tendency `z` and within | | | | | with measure of central |
| | | | an rolling window of | | | | | tendency `z` and within |
| | | | size `z`. Optionally the | | | | | an rolling window of |
| | | | `deriv`'s derivate of | | | | | size `z`. Optionally the |
| | | | the dataset is calculated | | | | | `deriv`'s derivate of |
| | | | first. | | | | | the dataset is calculated |
|-------|---------------------|---------------------|---------------------------| | | | | first. |
| | | | | | ----- | ------------------- | ------------------- | ------------------------- |
### User Defined Test ### User Defined Test
User defined tests allow to specify simple quality checks directly within the configuration. User defined tests allow to specify simple quality checks directly within the configuration.
...@@ -53,8 +54,8 @@ User defined tests allow to specify simple quality checks directly within the co ...@@ -53,8 +54,8 @@ User defined tests allow to specify simple quality checks directly within the co
- Example: generic, `{func: (thisvar > 0) & ismissing(othervar)}` - Example: generic, `{func: (thisvar > 0) & ismissing(othervar)}`
#### Restrictions #### Restrictions
- only the operators and functions listed below are available - only the operators and functions listed below are available
- all checks need to be conditional expression and have to return an array of boolean values. - all checks need to be conditional expression and have to return an array of boolean values,
All other expressions are rejected. This limitation is enforced to somewhat narrow the all other expressions are rejected. This limitation is enforced to somewhat narrow the
scope of the system and therefore the potential to mess things up and might as well be scope of the system and therefore the potential to mess things up and might as well be
removed in the future. removed in the future.
#### Syntax #### Syntax
...@@ -79,8 +80,9 @@ User defined tests allow to specify simple quality checks directly within the co ...@@ -79,8 +80,9 @@ User defined tests allow to specify simple quality checks directly within the co
#### Referencing Semantics #### Referencing Semantics
If another variable is reference within an generic test, the flags from that variable are If another variable is reference within an generic test, the flags from that variable are
propagated to the checked variable. For example: propagated to the checked variable.
For example:
Let `var1` and `var2` be two variables of a given dataset and `func: var1 > mean(var1)` Let `var1` and `var2` be two variables of a given dataset and `func: var1 > mean(var1)`
the condition wheter to flag `var2`. The result of the check can be described the condition wheter to flag `var2`. The result of the check can be described
as `isflagged(var1) & istrue(func)`. as `isflagged(var1) & istrue(func())`.
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