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

Update FunctionDescriptions.md

parent 2283a95b
No related branches found
No related tags found
No related merge requests found
# Implemented QC functions # Implemented QC functions
## range ## `range`
### Signature ### Signature
``` ```
range(min, max) range(min, max)
``` ```
### Parameters
| parameter | data type | default value | description |
| --------- | --------- | ------------- | ----------- |
| min | float | | |
| max | float | | |
### Description ### Description
## missing ## `missing`
### Signature ### Signature
``` ```
missing(nodata=NaN) missing(nodata=NaN)
``` ```
### Description
The Function flags those values in the the passed data series, that are
associated with "missing" data. The missing data indicator (`np.nan` by default)
, can be altered to any other value by passing this new value to the
parameter `nodata`.
| parameter | data format | description | ### Parameters
| ------ | ------ | ------ | | parameter | data type | default value | description |
| nodata | any Value. (Default = np.nan). | Any value, that shall indicate missing data in the passed dataseries. (If value is not `np.nan`, evaluation will be performed by `nodata == data`) | | --------- | ---------- | -------------- | ----------- |
| nodata | any | `NaN` | Value indicating missing values in the passed data |
## sesonalRange ### Description
The function flags those values in the the passed data series, that are
associated with "missing" data. The missing data indicator (default: `NaN`), can
be altered to any other value by passing this new value to the parameter `nodata`.
## `seasonalRange`
### Signature ### Signature
``` ```
sesonalRange(min, max, startmonth=1, endmonth=12, startday=1, endday=31) sesonalRange(min, max, startmonth=1, endmonth=12, startday=1, endday=31)
``` ```
### Parameters
| parameter | data type | default value | description |
| --------- | ----------- | ---- | ----------- |
| min | float | | |
| max | float | | |
| startmonth | integer | `1` | |
| endmonth | integer | `12` | |
| startday | integer | `1` | |
| endday | integer | `31` | |
## clear ## `clear`
### Signature ### Signature
``` ```
clear() clear()
``` ```
### Description
### Parameters
| parameter | data type | default value | description |
| --------- | ----------- | ---- | ----------- |
### Description
Remove all previously set flags.
## force ## force
### Signature ### Signature
......
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