Changes between Initial Version and Version 1 of BluePrint/TimePlot

Timestamp:

12/20/13 12:01:49 (12 years ago)

Author:

Dominic König

Comment:

--

BluePrint/TimePlot

@@ +1 @@
+= Timeplot Reports =
+[[TOC]]
+
+Timeplots report the development of aggregated process attributes over time, e.g.:
+
+  - the number of residents in a refugee camp
+  - the number of projects at a location
+  - the total amount of funding for a project
+  - the stock level of certain items in a warehouse
+
+These reports are represented as interactive graphs over a time axis.
+
+  '''Note:''' ''Timeplot reports should not be confused with timeline reports (which are used to show individual items along a time axis).''
+
+== Data Model ==
+
+For each data item we have the following fields:
+
+  - a numeric value (for count aggregation, this value is generally 1)
+  - a start date (can be None if that attribute has always existed)
+  - an end date (optional, can be None if the attribute is perpetual)
+
+== Functional Requirements ==
+
+=== Framework ===
+
+Timeplots are meant to become a generic, configurable reporting method (similar to S3Report2), which responds to the /timeplot method. 
+
+The method shall support both resource default options, URL options as well as interactive options selection (via Ajax-update).
+
+Timeplots shall support filtering, and (optionally) integrate a filter form.
+
+Timeplots shall support integration into S3Summary (widget-method) and S3Profile.
+
+Ideally, timeplots could also be exported (XLS, PDF, PNG).
+
+=== Aggregation methods ===
+
+Timeplot reports shall support the following aggregation methods:
+
+  - count (number of items)
+  - sum (total value)
+  - avg (average value)
+  - min (minimum value)
+  - max (maximum value)
+
+=== Multiple layers ===
+
+Timeplots shall be able to report multiple value dimensions in the same graph. These dimensions can be reported as overlays (for comparison) or stacked.
+
+=== Baseline Aggregation ===
+
+It shall be possible to specify a time interval for the analysis.
+
+To be able to specify a start date/time, we must calculate baselines, i.e. the aggregated attributes at the start of the analysis interval.
+
+=== Interval Aggregation ===
+
+It shall be possible to specify the resolution for the aggregation. This can be:
+
+  - hourly
+  - daily
+  - weekly
+  - monthly
+  - yearly
+  - continuous (=item timestamps define the intervals)
+  - automatic (= automatically adjust resolution after the length of the analysis interval)
+
+=== Graph Exploration ===
+
+The graphs shall provide interactive methods to explore each data point. This includes on-hover tooltips to display point data as well as options to use a data point to drill down into individual items.
+
+It shall be possible to switch between different graph types (lines or bars).
+
+== Implementation ==
+
+An early prototype of timeplots has been implemented in modules/s3/s3timeplot.py, the JavaScript can be found in statis/scripts/S3/s3.jquery.ui.timeplot.js.
+
+The prototype is using the flot library to generate the graphs.
+
+----
+[wiki:BluePrint]