Commit 399c9848 authored by LE GAC Renaud's avatar LE GAC Renaud
Browse files

Update report_objects.py to improve doc string.

parent 0f84f4ef
......@@ -293,6 +293,22 @@ class Graph(BaseReport):
the data are possible: plot, histogram, bar charts, error charts,
scater plots, *etc*.
Note:
Parameters to generate the graph are stored in the global
Storage ``request.vars`` as string:
- SelectorYear_start
- SelectorYear_end
- SelectorId_domains
- SelectorId_teams
- SelectorId_projects
- SelectorId_fundings
- SelectorId_people_categories
- SelectorId_people_code
- SelectorId_object_categories
- SelectorId_object_code
- SelectorData
Args:
table (gluon.dal.Table):
table containing configurations for reports.
......@@ -481,6 +497,22 @@ class List(BaseReport):
``Dbui.grid.Panel`` thought the underlying ``Ext.data.Store``.
Its configuration is returned by the method *to_store*.
Note:
Parameters to generate the list are stored in the global
Storage ``request.vars`` as string:
- SelectorYear_start
- SelectorYear_end
- SelectorId_domains
- SelectorId_teams
- SelectorId_projects
- SelectorId_fundings
- SelectorId_people_categories
- SelectorId_people_code
- SelectorId_object_categories
- SelectorId_object_code
- SelectorData
Args:
table (gluon.dal.Table): table containing configurations for reports.
id_report (int): identifier of the report in the table.
......@@ -812,6 +844,22 @@ class Metric1D(List):
A summary information can also be computed for each column or rows.
Note:
Parameters to generate the metric1D are stored in the global
Storage ``request.vars`` as string:
- SelectorYear_start
- SelectorYear_end
- SelectorId_domains
- SelectorId_teams
- SelectorId_projects
- SelectorId_fundings
- SelectorId_people_categories
- SelectorId_people_code
- SelectorId_object_categories
- SelectorId_object_code
- SelectorData
Args:
table (gluon.dal.Table): table containing configurations for reports.
id_report (int): identifier of the report in the table.
......@@ -1026,6 +1074,22 @@ class Metric2D(BaseReport):
``median``, ``min``, ``size``, ``std``, ``sum``, *etc*.
In fact, all the computation methods of the ``pandas.DataFrame`` class.
Note:
Parameters to generate the metric2D are stored in the global
Storage ``request.vars`` as string:
- SelectorYear_start
- SelectorYear_end
- SelectorId_domains
- SelectorId_teams
- SelectorId_projects
- SelectorId_fundings
- SelectorId_people_categories
- SelectorId_people_code
- SelectorId_object_categories
- SelectorId_object_code
- SelectorData
Args:
table (gluon.dal.Table): table containing configurations for reports.
id_report (int): identifier of the report in the table.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment