reporting
Metric
TODO: add documentation
Report
TODO: add documentation
metric(level, returntype)
A decorator for community metrics.
The parameters level and type determine how and using which level of
observation (topics, posts, etc.) the metrics' results are represented.
- Only methods using this decorator are available as metrics through
pici.Community.metrics.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
level |
pici.datatypes.CommunityDataLevel
|
The metric's data level Determines to which 'view' of pici.Community metric's results are appended to. |
required |
returntype |
pici.datatypes.MetricReturnType
|
Data type of metric's return value. |
required |
Returns:
| Type | Description |
|---|---|
Returns either plain metric value, or determined value(s) appended to community data.
Type determined by |
preprocessor(level)
A decorator for preprocessors.
report(func)
TODO: add documentation
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
func |
required |