blob: 90bedcb2a07addc722a19fc93b74e0d2fc18ae48 [file] [log] [blame]
<!-- HTML header for doxygen 1.8.4-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.4"/>
<meta name="keywords" content="madlib,postgres,greenplum,machine learning,data mining,deep learning,ensemble methods,data science,market basket analysis,affinity analysis,pca,lda,regression,elastic net,huber white,proportional hazards,k-means,latent dirichlet allocation,bayes,support vector machines,svm"/>
<title>MADlib: marginal.sql_in File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js", "TeX/AMSmath.js", "TeX/AMSsymbols.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script><script src="../mathjax/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="madlib_extra.css" rel="stylesheet" type="text/css"/>
<!-- google analytics -->
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-45382226-1', 'auto');
ga('send', 'pageview');
</script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">MADlib
&#160;<span id="projectnumber">1.4.1</span>
</div>
<div id="projectbrief">User Documentation</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.4 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('marginal_8sql__in.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Groups</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">marginal.sql_in File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>SQL functions for linear regression.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a2115a795562bc2928c3858fc55104c4b"><td class="memItemLeft" align="right" valign="top">float8[]&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="marginal_8sql__in.html#a2115a795562bc2928c3858fc55104c4b">marginal_logregr_step_transition</a> (float8[] state, boolean y, float8[] x, float8[] coef)</td></tr>
<tr class="separator:a2115a795562bc2928c3858fc55104c4b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae44a992f8bd650b5c1f0c2ffae7bb542"><td class="memItemLeft" align="right" valign="top">float8[]&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="marginal_8sql__in.html#ae44a992f8bd650b5c1f0c2ffae7bb542">marginal_logregr_step_merge_states</a> (float8[] state1, float8[] state2)</td></tr>
<tr class="separator:ae44a992f8bd650b5c1f0c2ffae7bb542"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac4e06a28a76651de70768457575bb9e0"><td class="memItemLeft" align="right" valign="top">marginal_logregr_result&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="marginal_8sql__in.html#ac4e06a28a76651de70768457575bb9e0">marginal_logregr_step_final</a> (float8[] state)</td></tr>
<tr class="separator:ac4e06a28a76651de70768457575bb9e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3286b644d2d51a8f2874896dc1b5d925"><td class="memItemLeft" align="right" valign="top">aggregate marginal_logregr_result&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="marginal_8sql__in.html#a3286b644d2d51a8f2874896dc1b5d925">marginal_logregr</a> (boolean dependentVariable, float8[] independentVariables, float8[] coef)</td></tr>
<tr class="memdesc:a3286b644d2d51a8f2874896dc1b5d925"><td class="mdescLeft">&#160;</td><td class="mdescRight">Compute marginal effects for logistic regression. <a href="#a3286b644d2d51a8f2874896dc1b5d925">More...</a><br/></td></tr>
<tr class="separator:a3286b644d2d51a8f2874896dc1b5d925"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9517d679ee4209126895445cbed51fe3"><td class="memItemLeft" align="right" valign="top">varchar&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="marginal_8sql__in.html#a9517d679ee4209126895445cbed51fe3">margins_logregr</a> (varchar message)</td></tr>
<tr class="separator:a9517d679ee4209126895445cbed51fe3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a63aba4148ce9bfcafea81d08e3797a1f"><td class="memItemLeft" align="right" valign="top">varchar&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="marginal_8sql__in.html#a63aba4148ce9bfcafea81d08e3797a1f">margins_logregr</a> ()</td></tr>
<tr class="separator:a63aba4148ce9bfcafea81d08e3797a1f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a99dd17e30e4fcc2f39da4e671406bcea"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="marginal_8sql__in.html#a99dd17e30e4fcc2f39da4e671406bcea">margins_logregr</a> (varchar source_table, varchar out_table, varchar dependent_varname, varchar independent_varname, varchar grouping_cols, integer[] marginal_vars, integer max_iter, varchar optimizer, float8 tolerance, boolean verbose_mode)</td></tr>
<tr class="memdesc:a99dd17e30e4fcc2f39da4e671406bcea"><td class="mdescLeft">&#160;</td><td class="mdescRight">A wrapper function for the various marginal regression analyzes. <a href="#a99dd17e30e4fcc2f39da4e671406bcea">More...</a><br/></td></tr>
<tr class="separator:a99dd17e30e4fcc2f39da4e671406bcea"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3da4c52dd785c7d27d1df40713e2307a"><td class="memItemLeft" align="right" valign="top">CREATE OR REPLACE FUNCTION MADlib&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="marginal_8sql__in.html#a3da4c52dd785c7d27d1df40713e2307a">margins_logregr</a> (source_table VARCHAR--name of input table, out_table VARCHAR--name of output table, dependent_variable VARCHAR--name of dependent variable, independent_variable VARCHAR--name of independent variable) RETURNS VOID <a class="el" href="linear_8sql__in.html#a9d6de4f6e8483f60278bd93c7d0827d6">AS</a> $$SELECT MADlib.margins_logregr($1</td></tr>
<tr class="memdesc:a3da4c52dd785c7d27d1df40713e2307a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Marginal effects with default variables. <a href="#a3da4c52dd785c7d27d1df40713e2307a">More...</a><br/></td></tr>
<tr class="separator:a3da4c52dd785c7d27d1df40713e2307a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4942fd3e73e32e670450e45f21b2566e"><td class="memItemLeft" align="right" valign="top">CREATE OR REPLACE FUNCTION MADlib&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="marginal_8sql__in.html#a4942fd3e73e32e670450e45f21b2566e">margins_logregr</a> (source_table VARCHAR--name of input table, out_table VARCHAR--name of output table, dependent_variable VARCHAR--name of dependent variable, independent_variable VARCHAR--name of independent variable, grouping_cols VARCHAR--name of grouping cols) RETURNS VOID <a class="el" href="linear_8sql__in.html#a9d6de4f6e8483f60278bd93c7d0827d6">AS</a> $$SELECT MADlib.margins_logregr($1</td></tr>
<tr class="memdesc:a4942fd3e73e32e670450e45f21b2566e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Marginal effects with default variable_names. <a href="#a4942fd3e73e32e670450e45f21b2566e">More...</a><br/></td></tr>
<tr class="separator:a4942fd3e73e32e670450e45f21b2566e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adef52655aaba4256eb66424550720faa"><td class="memItemLeft" align="right" valign="top">CREATE OR REPLACE FUNCTION MADlib&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="marginal_8sql__in.html#adef52655aaba4256eb66424550720faa">margins_logregr</a> (source_table VARCHAR--name of input table, out_table VARCHAR--name of output table, dependent_variable VARCHAR--name of dependent variable, independent_variable VARCHAR--name of independent variable, grouping_cols VARCHAR--name of grouping cols, marginal_vars INTEGER[]--indices of variables to calculate marginal effects on) RETURNS VOID <a class="el" href="linear_8sql__in.html#a9d6de4f6e8483f60278bd93c7d0827d6">AS</a> $$SELECT MADlib.margins_logregr($1</td></tr>
<tr class="memdesc:adef52655aaba4256eb66424550720faa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Marginal effects with default variable_names. <a href="#adef52655aaba4256eb66424550720faa">More...</a><br/></td></tr>
<tr class="separator:adef52655aaba4256eb66424550720faa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a306bb861739f24aef86f1e494645c95e"><td class="memItemLeft" align="right" valign="top">CREATE OR REPLACE FUNCTION MADlib&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="marginal_8sql__in.html#a306bb861739f24aef86f1e494645c95e">margins_logregr</a> (source_table VARCHAR--name of input table, out_table VARCHAR--name of output table, dependent_variable VARCHAR--name of dependent variable, independent_variable VARCHAR--name of independent variable, grouping_cols VARCHAR--name of grouping cols, marginal_vars INTEGER[]--indices of variables to calculate marginal effects on, max_iter INTEGER--Max iterations for the logstic regression inner call) RETURNS VOID <a class="el" href="linear_8sql__in.html#a9d6de4f6e8483f60278bd93c7d0827d6">AS</a> $$SELECT MADlib.margins_logregr($1</td></tr>
<tr class="memdesc:a306bb861739f24aef86f1e494645c95e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Marginal effects with default variable_names. <a href="#a306bb861739f24aef86f1e494645c95e">More...</a><br/></td></tr>
<tr class="separator:a306bb861739f24aef86f1e494645c95e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a265517ef79c8ced01cf6d3fa48ee0edc"><td class="memItemLeft" align="right" valign="top">CREATE OR REPLACE FUNCTION MADlib&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="marginal_8sql__in.html#a265517ef79c8ced01cf6d3fa48ee0edc">margins_logregr</a> (source_table VARCHAR--name of input table, out_table VARCHAR--name of output table, dependent_variable VARCHAR--name of dependent variable, independent_variable VARCHAR--name of independent variable, grouping_cols VARCHAR--name of grouping cols, marginal_vars INTEGER[]--indices of variables to calculate marginal effects on, max_iter INTEGER--Max iterations for the logstic regression inner call, optimizer VARCHAR--Logistic regression optimizer) RETURNS VOID <a class="el" href="linear_8sql__in.html#a9d6de4f6e8483f60278bd93c7d0827d6">AS</a> $$SELECT MADlib.margins_logregr($1</td></tr>
<tr class="memdesc:a265517ef79c8ced01cf6d3fa48ee0edc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Marginal effects with default variable_names. <a href="#a265517ef79c8ced01cf6d3fa48ee0edc">More...</a><br/></td></tr>
<tr class="separator:a265517ef79c8ced01cf6d3fa48ee0edc"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a1bcd2f9adc5825caadb97a9fe1838b8a"><td class="memItemLeft" align="right" valign="top">CREATE OR REPLACE FUNCTION MADlib&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="marginal_8sql__in.html#a1bcd2f9adc5825caadb97a9fe1838b8a">NULL</a></td></tr>
<tr class="separator:a1bcd2f9adc5825caadb97a9fe1838b8a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aef65f6991b54dc3fe364f1ba10588507"><td class="memItemLeft" align="right" valign="top">CREATE OR REPLACE FUNCTION MADlib&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="marginal_8sql__in.html#aef65f6991b54dc3fe364f1ba10588507">irls</a></td></tr>
<tr class="separator:aef65f6991b54dc3fe364f1ba10588507"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae486a58736396e79d133f5b07e6cf5dd"><td class="memItemLeft" align="right" valign="top">CREATE OR REPLACE FUNCTION MADlib&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="marginal_8sql__in.html#ae486a58736396e79d133f5b07e6cf5dd">False</a></td></tr>
<tr class="separator:ae486a58736396e79d133f5b07e6cf5dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5c260c171369c3ce2b3aa0052d173960"><td class="memItemLeft" align="right" valign="top">LANGUAGE <a class="el" href="linear_8sql__in.html#a7e8f2ef77d769bc7c85e5ff69b42ef2d">sql</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="marginal_8sql__in.html#a5c260c171369c3ce2b3aa0052d173960">VOLATILE</a></td></tr>
<tr class="separator:a5c260c171369c3ce2b3aa0052d173960"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><dl class="section date"><dt>Date</dt><dd>January 2011</dd></dl>
<dl class="section see"><dt>See Also</dt><dd>Calculates marginal effects for various regression models. </dd></dl>
</div><h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a3286b644d2d51a8f2874896dc1b5d925"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">aggregate marginal_logregr_result marginal_logregr </td>
<td>(</td>
<td class="paramtype">boolean&#160;</td>
<td class="paramname"><em>dependentVariable</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float8[]&#160;</td>
<td class="paramname"><em>independentVariables</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float8[]&#160;</td>
<td class="paramname"><em>coef</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dependentVariable</td><td>Column containing the dependent variable </td></tr>
<tr><td class="paramname">independentVariables</td><td>Column containing the array of independent variables </td></tr>
<tr><td class="paramname">coef</td><td>Column containing the array of the coefficients (as obtained by logregr)</td></tr>
</table>
</dd>
</dl>
<dl class="section user"><dt></dt><dd>To include an intercept in the model, set one coordinate in the <code>independentVariables</code> array to 1.</dd></dl>
<dl class="section return"><dt>Returns</dt><dd>A composite value:<ul>
<li><code>margins FLOAT8[] </code> - Array of marginal effects</li>
<li><code>coefFLOAT8[] </code> - The coefficients for the regression</li>
<li><code>std_err FLOAT8[]</code> - Array of standard-errors (calculated by the delta method),</li>
<li><code>z_stats FLOAT8[]</code> - Array of z-statistics</li>
<li><code>p_values FLOAT8[]</code> - Array of p-values</li>
</ul>
</dd></dl>
<dl class="section user"><dt>Usage</dt><dd><ul>
<li>Get all the diagnostic statistics:<br/>
</li>
</ul>
</dd></dl>
<pre> SELECT marginal_logregr(<em>dependentVariable</em>,
<em>independentVariables</em>, coef)
FROM <em>dataTable</em>;
</pre>
</div>
</div>
<a class="anchor" id="ac4e06a28a76651de70768457575bb9e0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">marginal_logregr_result marginal_logregr_step_final </td>
<td>(</td>
<td class="paramtype">float8[]&#160;</td>
<td class="paramname"><em>state</em>)</td><td></td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ae44a992f8bd650b5c1f0c2ffae7bb542"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float8 [] marginal_logregr_step_merge_states </td>
<td>(</td>
<td class="paramtype">float8[]&#160;</td>
<td class="paramname"><em>state1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float8[]&#160;</td>
<td class="paramname"><em>state2</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a2115a795562bc2928c3858fc55104c4b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float8 [] marginal_logregr_step_transition </td>
<td>(</td>
<td class="paramtype">float8[]&#160;</td>
<td class="paramname"><em>state</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">boolean&#160;</td>
<td class="paramname"><em>y</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float8[]&#160;</td>
<td class="paramname"><em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float8[]&#160;</td>
<td class="paramname"><em>coef</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a9517d679ee4209126895445cbed51fe3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">varchar margins_logregr </td>
<td>(</td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>message</em>)</td><td></td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a63aba4148ce9bfcafea81d08e3797a1f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">varchar margins_logregr </td>
<td>(</td>
<td class="paramname">)</td><td></td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a99dd17e30e4fcc2f39da4e671406bcea"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void margins_logregr </td>
<td>(</td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>source_table</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>out_table</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>dependent_varname</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>independent_varname</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>grouping_cols</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">integer[]&#160;</td>
<td class="paramname"><em>marginal_vars</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">integer&#160;</td>
<td class="paramname"><em>max_iter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">varchar&#160;</td>
<td class="paramname"><em>optimizer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float8&#160;</td>
<td class="paramname"><em>tolerance</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">boolean&#160;</td>
<td class="paramname"><em>verbose_mode</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">source_table</td><td>String identifying the input table </td></tr>
<tr><td class="paramname">out_table</td><td>String identifying the output table to be created </td></tr>
<tr><td class="paramname">dependent_varname</td><td>Column containing the dependent variable </td></tr>
<tr><td class="paramname">independent_varname</td><td>Column containing the array of independent variables </td></tr>
<tr><td class="paramname">grouping_cols</td><td>Set of columns to group by. </td></tr>
<tr><td class="paramname">marginal_vars</td><td>Subset of independent variables to calculate marginal effects for. </td></tr>
<tr><td class="paramname">max_iter</td><td>Maximum number of iterations </td></tr>
<tr><td class="paramname">optimzer</td><td>Optimizer to be used (newton/irls, cg or idg) </td></tr>
<tr><td class="paramname">tolerance</td><td>Resiual tolerance </td></tr>
<tr><td class="paramname">verbose_mode</td><td>Verbose mode (on/off)</td></tr>
</table>
</dd>
</dl>
<dl class="section user"><dt></dt><dd>To include an intercept in the model, set one coordinate in the <code>independentVariables</code> array to 1.</dd></dl>
<dl class="section return"><dt>Returns</dt><dd>void</dd></dl>
<dl class="section user"><dt>Usage</dt><dd>For function summary information. Run sql&gt; select margins_logregr('help'); OR sql&gt; select <a class="el" href="marginal_8sql__in.html#a9517d679ee4209126895445cbed51fe3">margins_logregr()</a>; OR sql&gt; select margins_logregr('?'); For function usage information. Run sql&gt; select margins_logregr('usage');<ul>
<li>Compute the coefficients, and the get the marginal diagnostic statistics: <pre>
select margins_logregr(source_table, out_table, dependentVariable, independentVariables);
</pre> </li>
</ul>
</dd></dl>
</div>
</div>
<a class="anchor" id="a3da4c52dd785c7d27d1df40713e2307a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CREATE OR REPLACE FUNCTION MADlib margins_logregr </td>
<td>(</td>
<td class="paramtype">source_table VARCHAR--name of input&#160;</td>
<td class="paramname"><em>table</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">out_table VARCHAR--name of output&#160;</td>
<td class="paramname"><em>table</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">dependent_variable VARCHAR--name of dependent&#160;</td>
<td class="paramname"><em>variable</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">independent_variable VARCHAR--name of independent&#160;</td>
<td class="paramname"><em>variable</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a4942fd3e73e32e670450e45f21b2566e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CREATE OR REPLACE FUNCTION MADlib margins_logregr </td>
<td>(</td>
<td class="paramtype">source_table VARCHAR--name of input&#160;</td>
<td class="paramname"><em>table</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">out_table VARCHAR--name of output&#160;</td>
<td class="paramname"><em>table</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">dependent_variable VARCHAR--name of dependent&#160;</td>
<td class="paramname"><em>variable</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">independent_variable VARCHAR--name of independent&#160;</td>
<td class="paramname"><em>variable</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">grouping_cols VARCHAR--name of grouping&#160;</td>
<td class="paramname"><em>cols</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="adef52655aaba4256eb66424550720faa"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CREATE OR REPLACE FUNCTION MADlib margins_logregr </td>
<td>(</td>
<td class="paramtype">source_table VARCHAR--name of input&#160;</td>
<td class="paramname"><em>table</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">out_table VARCHAR--name of output&#160;</td>
<td class="paramname"><em>table</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">dependent_variable VARCHAR--name of dependent&#160;</td>
<td class="paramname"><em>variable</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">independent_variable VARCHAR--name of independent&#160;</td>
<td class="paramname"><em>variable</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">grouping_cols VARCHAR--name of grouping&#160;</td>
<td class="paramname"><em>cols</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">marginal_vars INTEGER--[]indices of variables to calculate marginal effects&#160;</td>
<td class="paramname"><em>on</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a306bb861739f24aef86f1e494645c95e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CREATE OR REPLACE FUNCTION MADlib margins_logregr </td>
<td>(</td>
<td class="paramtype">source_table VARCHAR--name of input&#160;</td>
<td class="paramname"><em>table</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">out_table VARCHAR--name of output&#160;</td>
<td class="paramname"><em>table</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">dependent_variable VARCHAR--name of dependent&#160;</td>
<td class="paramname"><em>variable</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">independent_variable VARCHAR--name of independent&#160;</td>
<td class="paramname"><em>variable</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">grouping_cols VARCHAR--name of grouping&#160;</td>
<td class="paramname"><em>cols</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">marginal_vars INTEGER--[]indices of variables to calculate marginal effects&#160;</td>
<td class="paramname"><em>on</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">max_iter INTEGER--Max iterations for the logstic regression inner&#160;</td>
<td class="paramname"><em>call</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a265517ef79c8ced01cf6d3fa48ee0edc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CREATE OR REPLACE FUNCTION MADlib margins_logregr </td>
<td>(</td>
<td class="paramtype">source_table VARCHAR--name of input&#160;</td>
<td class="paramname"><em>table</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">out_table VARCHAR--name of output&#160;</td>
<td class="paramname"><em>table</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">dependent_variable VARCHAR--name of dependent&#160;</td>
<td class="paramname"><em>variable</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">independent_variable VARCHAR--name of independent&#160;</td>
<td class="paramname"><em>variable</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">grouping_cols VARCHAR--name of grouping&#160;</td>
<td class="paramname"><em>cols</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">marginal_vars INTEGER--[]indices of variables to calculate marginal effects&#160;</td>
<td class="paramname"><em>on</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">max_iter INTEGER--Max iterations for the logstic regression inner&#160;</td>
<td class="paramname"><em>call</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">optimizer VARCHAR--Logistic regression&#160;</td>
<td class="paramname"><em>optimizer</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a class="anchor" id="ae486a58736396e79d133f5b07e6cf5dd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CREATE OR REPLACE FUNCTION MADlib False</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="aef65f6991b54dc3fe364f1ba10588507"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CREATE OR REPLACE FUNCTION MADlib irls</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a1bcd2f9adc5825caadb97a9fe1838b8a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">CREATE OR REPLACE FUNCTION MADlib NULL</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a5c260c171369c3ce2b3aa0052d173960"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LANGUAGE <a class="el" href="linear_8sql__in.html#a7e8f2ef77d769bc7c85e5ff69b42ef2d">sql</a> VOLATILE</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_efbcf68973d247bbf15f9eecae7f24e3.html">ports</a></li><li class="navelem"><a class="el" href="dir_a4a48839224ef8488facbffa8a397967.html">postgres</a></li><li class="navelem"><a class="el" href="dir_dc596537ad427a4d866006d1a3e1fe29.html">modules</a></li><li class="navelem"><a class="el" href="dir_ac52a4b89b7b1b1591f2952b5cbd041a.html">regress</a></li><li class="navelem"><a class="el" href="marginal_8sql__in.html">marginal.sql_in</a></li>
<li class="footer">Generated on Thu Jan 9 2014 20:25:06 for MADlib by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.4 </li>
</ul>
</div>
</body>
</html>