Changes between Version 37 and Version 38 of S3/S3Report


Ignore:
Timestamp:
03/15/14 06:19:49 (8 years ago)
Author:
Michael Howden
Comment:

Deprication of S3Report1

Legend:

Unmodified
Added
Removed
Modified
  • S3/S3Report

    v37 v38  
    44S3Report is a REST method handler for data analysis.
    55
    6   ''S3Report currently exists in two versions: S3Report (based on S3Search, to be deprecated) and S3Report2 (based on Ajax filter forms). Any new pages should always use S3Report2 (URL method /report2).''
    76== Functionality ==
    87S3Report generates a full page which includes a set of S3Search widgets, a pivot table (a.k.a. contingency table) from S3Resources and graphs based on the Pivot Tables.
    9 
    10 == Versions ==
    11 There are currently 2 versions:
    12 * /report based on the old S3Search: https://github.com/flavour/eden/blob/master/modules/s3/s3report.py
    13 * /report2 which supports AJAX updates and is based on the new S3Filter: https://github.com/flavour/eden/blob/master/modules/s3/s3report2.py
    148
    159== Caveats ==
     
    3832== URL Methods ==
    3933
    40 S3Report responds to the {{{/report}}} URL method (S3Report2 uses /report2), for ''all'' resources (generic method).
     34S3Report responds to the {{{/report}}} URL method for ''all'' resources (generic method).
    4135
    4236The following parameters are accepted:
     
    4539  ||rows||the name of the field to be used for the table rows||yes||
    4640  ||cols||the name of the field to be used for the table columns||no (if no cols are specified, all instance values appear in 1 column)||
    47   ||fact||S3Report: the name of the fact field, S3Report2: aggregation function fact=method(selector)||yes||
    48   ||aggregate||the aggregation method||no longer supported in S3Report2, use fact=method(selector) syntax instead||
     41  ||fact||aggregation function fact=method(selector)||yes||
    4942  ||table||whether to hide the pivot table (table=0) or show it (table=1)||no||
    5043  ||chart||render as chart by default, format: chart=<type>:<dimension>||no||