Skip to content

Commit 17debe6

Browse files
Statistical generator API doc and minor typo fix (#165)
1 parent 38ba103 commit 17debe6

File tree

2 files changed

+78
-1
lines changed

2 files changed

+78
-1
lines changed

codegen/pyadritem.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ class Item:
4848

4949

5050
The type of the item created in the preceding code cannot be changed. However,
51-
the attributes describing the object can be reset at any time. These hanges are
51+
the attributes describing the object can be reset at any time. These changes are
5252
automatically propagated into the database. The attributes described in the
5353
following "Parameters" section can be used to control the rendering of these objects.
5454

doc/source/lowlevelapi/TemplateObjects.rst

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -325,6 +325,9 @@ sqlqueries `SQL Query`_ :ref:`report_objects.sqlqu
325325

326326
treemerge `Tree Merge`_ :ref:`report_objects.mergetreeREST()
327327
<mergetreeREST>`
328+
329+
statistical `Statistical Analysis`_ :ref:`report_objects.statisticalREST()
330+
<statisticalREST>`
328331
======================= ============================= ========================================
329332

330333

@@ -1691,3 +1694,77 @@ header.
16911694
Set the name of the tag to be used to generate an output tree header.
16921695
Input needs to be a string. An empty string (the default) specifies that
16931696
no tree header be generated.
1697+
1698+
.. _statisticalREST:
1699+
1700+
statisticalREST object
1701+
^^^^^^^^^^^^^^^^^^^^
1702+
1703+
Inherits from TemplateREST, GeneratorREST
1704+
1705+
Class that corresponds to the Statistical Analysis Generator
1706+
template type. Its specific methods are:
1707+
1708+
**template.get_analysis_type()**
1709+
1710+
Get the type of statistical analysis
1711+
1712+
**Template.set_analysis_type(value=””)**
1713+
1714+
Set the type of statistical analysis.
1715+
Only “Linear Regression” is supported.
1716+
1717+
**Template.get_table_name()**
1718+
1719+
Get the name of the output table.
1720+
1721+
**Template.set_table_name(value=””)**
1722+
1723+
Set the name of the output table. Input must be a string.
1724+
1725+
**Template.get_tree_name()**
1726+
1727+
Get the name of the output tree with statistical parameters values.
1728+
1729+
**Template.set_tree_name(value=””)**
1730+
1731+
Set the name of the output tree with statistical parameters values.
1732+
Input must be a string.
1733+
1734+
**Template.set_predictor_variables(value)**
1735+
1736+
Set the predictor variables. The input needs to be a list,
1737+
with each element a list of length 3.
1738+
The elements of the sub-lists must be:
1739+
1740+
- Type. Only “row” is currently supported.
1741+
- Variable predictor name.
1742+
- Output row name.
1743+
1744+
**Template.get_predictor_variables()**
1745+
1746+
Get the list of predictor variables.
1747+
Returns a list where each element is a sub-list of
1748+
3 elements (type, predictor name, output name)
1749+
1750+
**Template.set_response_variables(value=””)**
1751+
1752+
Set the response variables. Input must be a list of sub-lists,
1753+
each with two elements:
1754+
1755+
- Response variable name
1756+
- Output row name
1757+
1758+
**Template.get_response_variables()**
1759+
1760+
Get the response variable list. Each element is a sub-list
1761+
with two elements each.
1762+
1763+
**Template.set_analysis_params(value=””)**
1764+
1765+
Set the parameters for the statistical analysis.
1766+
Currently not supported.
1767+
1768+
**Template.get_analysis_params()**
1769+
1770+
Get the parameters for the statistical algorithm.

0 commit comments

Comments
 (0)