coef.joinet.html 8.03 KB
Newer Older
Armin Rauschenberger's avatar
Armin Rauschenberger committed
1 2
<!-- Generated by pkgdown: do not edit by hand -->
<!DOCTYPE html>
Armin Rauschenberger's avatar
Armin Rauschenberger committed
3
<html lang="en">
Armin Rauschenberger's avatar
Armin Rauschenberger committed
4 5 6 7 8
  <head>
  <meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">

Armin Rauschenberger's avatar
Armin Rauschenberger committed
9
<title>Extract Coefficients — coef.joinet • joinet</title>
Armin Rauschenberger's avatar
Armin Rauschenberger committed
10 11

<!-- jquery -->
Armin Rauschenberger's avatar
Armin Rauschenberger committed
12
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.3.1/jquery.min.js" integrity="sha256-FgpCb/KJQlLNfOu91ta32o/NMZxltwRo8QtmkMRdAu8=" crossorigin="anonymous"></script>
Armin Rauschenberger's avatar
Armin Rauschenberger committed
13
<!-- Bootstrap -->
Armin Rauschenberger's avatar
Armin Rauschenberger committed
14
<link href="https://cdnjs.cloudflare.com/ajax/libs/bootswatch/3.3.7/spacelab/bootstrap.min.css" rel="stylesheet" crossorigin="anonymous" />
Armin Rauschenberger's avatar
Armin Rauschenberger committed
15

Armin Rauschenberger's avatar
Armin Rauschenberger committed
16
<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha256-U5ZEeKfGNOja007MMD3YBI0A3OSZOQbeG6z2f2Y0hu8=" crossorigin="anonymous"></script>
Armin Rauschenberger's avatar
Armin Rauschenberger committed
17 18

<!-- Font Awesome icons -->
Armin Rauschenberger's avatar
Armin Rauschenberger committed
19
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css" integrity="sha256-eZrrJcwDc/3uDhsdt61sL2oOBY362qM3lon1gyExkL0=" crossorigin="anonymous" />
Armin Rauschenberger's avatar
Armin Rauschenberger committed
20 21

<!-- clipboard.js -->
Armin Rauschenberger's avatar
Armin Rauschenberger committed
22
<script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.4/clipboard.min.js" integrity="sha256-FiZwavyI2V6+EXO1U+xzLG3IKldpiTFf3153ea9zikQ=" crossorigin="anonymous"></script>
Armin Rauschenberger's avatar
Armin Rauschenberger committed
23 24 25 26 27 28 29 30 31 32

<!-- sticky kit -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/sticky-kit/1.1.3/sticky-kit.min.js" integrity="sha256-c4Rlo1ZozqTPE2RLuvbusY3+SU1pQaJC0TjuhygMipw=" crossorigin="anonymous"></script>

<!-- pkgdown -->
<link href="../pkgdown.css" rel="stylesheet">
<script src="../pkgdown.js"></script>



Armin Rauschenberger's avatar
Armin Rauschenberger committed
33
<meta property="og:title" content="Extract Coefficients — coef.joinet" />
Armin Rauschenberger's avatar
Armin Rauschenberger committed
34

Armin Rauschenberger's avatar
Armin Rauschenberger committed
35
<meta property="og:description" content="Extracts pooled coefficients.
Armin Rauschenberger's avatar
Armin Rauschenberger committed
36 37
(The meta learners linearly combines
the coefficients from the base learners.)" />
Armin Rauschenberger's avatar
Armin Rauschenberger committed
38 39 40 41 42
<meta name="twitter:card" content="summary" />



<!-- mathjax -->
Armin Rauschenberger's avatar
Armin Rauschenberger committed
43 44
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script>
Armin Rauschenberger's avatar
Armin Rauschenberger committed
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59

<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]-->


  </head>

  <body>
    <div class="container template-reference-topic">
      <header>
      <div class="navbar navbar-default navbar-fixed-top" role="navigation">
  <div class="container">
    <div class="navbar-header">
Armin Rauschenberger's avatar
Armin Rauschenberger committed
60 61
      <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false">
        <span class="sr-only">Toggle navigation</span>
Armin Rauschenberger's avatar
Armin Rauschenberger committed
62 63 64 65 66
        <span class="icon-bar"></span>
        <span class="icon-bar"></span>
        <span class="icon-bar"></span>
      </button>
      <span class="navbar-brand">
Armin Rauschenberger's avatar
Armin Rauschenberger committed
67
        <a class="navbar-link" href="../index.html">joinet</a>
Armin Rauschenberger's avatar
Armin Rauschenberger committed
68
        <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Released version">0.0.1</span>
Armin Rauschenberger's avatar
Armin Rauschenberger committed
69 70 71 72 73 74
      </span>
    </div>

    <div id="navbar" class="navbar-collapse collapse">
      <ul class="nav navbar-nav">
        <li>
Armin Rauschenberger's avatar
Armin Rauschenberger committed
75
  <a href="../reference/index.html">functions</a>
Armin Rauschenberger's avatar
Armin Rauschenberger committed
76 77
</li>
<li>
Armin Rauschenberger's avatar
Armin Rauschenberger committed
78
  <a href="../articles/vignette.html">vignette</a>
Armin Rauschenberger's avatar
Armin Rauschenberger committed
79
</li>
Armin Rauschenberger's avatar
Armin Rauschenberger committed
80 81
<li>
  <a href="../articles/article.html">article</a>
Armin Rauschenberger's avatar
Armin Rauschenberger committed
82 83
</li>
<li>
Armin Rauschenberger's avatar
Armin Rauschenberger committed
84
  <a href="../news/index.html">news</a>
Armin Rauschenberger's avatar
Armin Rauschenberger committed
85 86 87 88 89
</li>
      </ul>
      
      <ul class="nav navbar-nav navbar-right">
        <li>
Armin Rauschenberger's avatar
Armin Rauschenberger committed
90
  <a href="https://github.com/rauschenberger/joinet">
Armin Rauschenberger's avatar
Armin Rauschenberger committed
91 92 93 94 95
    <span class="fa fa-github"></span>
     
  </a>
</li>
<li>
Armin Rauschenberger's avatar
Armin Rauschenberger committed
96
  <a href="https://cran.r-project.org/package=joinet">
Armin Rauschenberger's avatar
Armin Rauschenberger committed
97
    <span class="fa fa-download"></span>
Armin Rauschenberger's avatar
Armin Rauschenberger committed
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112
     
  </a>
</li>
      </ul>
      
    </div><!--/.nav-collapse -->
  </div><!--/.container -->
</div><!--/.navbar -->

      
      </header>

<div class="row">
  <div class="col-md-9 contents">
    <div class="page-header">
Armin Rauschenberger's avatar
Armin Rauschenberger committed
113
    <h1>Extract Coefficients</h1>
Armin Rauschenberger's avatar
Armin Rauschenberger committed
114
    <small class="dont-index">Source: <a href='https://github.com/rauschenberger/mixnet/blob/master/R/functions.R'><code>R/functions.R</code></a></small>
Armin Rauschenberger's avatar
Armin Rauschenberger committed
115
    <div class="hidden name"><code>coef.joinet.Rd</code></div>
Armin Rauschenberger's avatar
Armin Rauschenberger committed
116 117 118 119
    </div>

    <div class="ref-description">
    
Armin Rauschenberger's avatar
Armin Rauschenberger committed
120
    <p>Extracts pooled coefficients.
Armin Rauschenberger's avatar
Armin Rauschenberger committed
121 122
(The meta learners linearly combines
the coefficients from the base learners.)</p>
Armin Rauschenberger's avatar
Armin Rauschenberger committed
123 124 125
    
    </div>

Armin Rauschenberger's avatar
Armin Rauschenberger committed
126
    <pre class="usage"><span class='co'># S3 method for joinet</span>
Armin Rauschenberger's avatar
Armin Rauschenberger committed
127
<span class='fu'><a href='https://www.rdocumentation.org/packages/stats/topics/coef'>coef</a></span>(<span class='no'>object</span>, <span class='no'>...</span>)</pre>
Armin Rauschenberger's avatar
Armin Rauschenberger committed
128 129 130 131 132
    
    <h2 class="hasAnchor" id="arguments"><a class="anchor" href="#arguments"></a>Arguments</h2>
    <table class="ref-arguments">
    <colgroup><col class="name" /><col class="desc" /></colgroup>
    <tr>
Armin Rauschenberger's avatar
Armin Rauschenberger committed
133
      <th>object</th>
Armin Rauschenberger's avatar
Armin Rauschenberger committed
134
      <td><p><a href='joinet.html'>joinet</a> object</p></td>
Armin Rauschenberger's avatar
Armin Rauschenberger committed
135 136 137 138 139 140 141
    </tr>
    <tr>
      <th>...</th>
      <td><p>further arguments (not applicable)</p></td>
    </tr>
    </table>
    
Armin Rauschenberger's avatar
Armin Rauschenberger committed
142 143 144 145 146 147 148 149
    <h2 class="hasAnchor" id="value"><a class="anchor" href="#value"></a>Value</h2>

    <p>This function returns the pooled coefficients.
The slot <code>alpha</code> contains the intercepts
in a vector of length \(q\),
and the slot <code>beta</code> contains the slopes
in a matrix with \(p\) rows (inputs) and \(q\) columns.</p>
    
Armin Rauschenberger's avatar
Armin Rauschenberger committed
150 151

    <h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2>
Armin Rauschenberger's avatar
Armin Rauschenberger committed
152
    <pre class="examples"><div class='input'><span class='no'>n</span> <span class='kw'>&lt;-</span> <span class='fl'>50</span>; <span class='no'>q</span> <span class='kw'>&lt;-</span> <span class='fl'>3</span>; <span class='no'>p</span> <span class='kw'>&lt;-</span> <span class='fl'>100</span>
Armin Rauschenberger's avatar
Armin Rauschenberger committed
153
<span class='no'>X</span> <span class='kw'>&lt;-</span> <span class='fu'><a href='https://www.rdocumentation.org/packages/base/topics/matrix'>matrix</a></span>(<span class='fu'><a href='https://www.rdocumentation.org/packages/stats/topics/Normal'>rnorm</a></span>(<span class='no'>n</span>*<span class='no'>p</span>),<span class='kw'>nrow</span><span class='kw'>=</span><span class='no'>n</span>,<span class='kw'>ncol</span><span class='kw'>=</span><span class='no'>p</span>)
Armin Rauschenberger's avatar
Armin Rauschenberger committed
154
<span class='no'>Y</span> <span class='kw'>&lt;-</span> <span class='fu'><a href='https://www.rdocumentation.org/packages/base/topics/lapply'>replicate</a></span>(<span class='kw'>n</span><span class='kw'>=</span><span class='no'>q</span>,<span class='kw'>expr</span><span class='kw'>=</span><span class='fu'><a href='https://www.rdocumentation.org/packages/stats/topics/Normal'>rnorm</a></span>(<span class='kw'>n</span><span class='kw'>=</span><span class='no'>n</span>,<span class='kw'>mean</span><span class='kw'>=</span><span class='fu'><a href='https://www.rdocumentation.org/packages/base/topics/colSums'>rowSums</a></span>(<span class='no'>X</span>[,<span class='fl'>1</span>:<span class='fl'>5</span>])))
Armin Rauschenberger's avatar
Armin Rauschenberger committed
155
<span class='no'>object</span> <span class='kw'>&lt;-</span> <span class='fu'><a href='joinet.html'>joinet</a></span>(<span class='kw'>Y</span><span class='kw'>=</span><span class='no'>Y</span>,<span class='kw'>X</span><span class='kw'>=</span><span class='no'>X</span>)
Armin Rauschenberger's avatar
Armin Rauschenberger committed
156
<span class='no'>coef</span> <span class='kw'>&lt;-</span> <span class='fu'><a href='https://www.rdocumentation.org/packages/stats/topics/coef'>coef</a></span>(<span class='no'>object</span>)</div></pre>
Armin Rauschenberger's avatar
Armin Rauschenberger committed
157 158 159 160 161
  </div>
  <div class="col-md-3 hidden-xs hidden-sm" id="sidebar">
    <h2>Contents</h2>
    <ul class="nav nav-pills nav-stacked">
      <li><a href="#arguments">Arguments</a></li>
Armin Rauschenberger's avatar
Armin Rauschenberger committed
162 163 164
      
      <li><a href="#value">Value</a></li>
      
Armin Rauschenberger's avatar
Armin Rauschenberger committed
165 166 167 168 169 170 171 172
      <li><a href="#examples">Examples</a></li>
    </ul>

  </div>
</div>

      <footer>
      <div class="copyright">
Armin Rauschenberger's avatar
Armin Rauschenberger committed
173
  <p>Developed by <a href='https://rauschenberger.github.io'>Armin Rauschenberger</a>.</p>
Armin Rauschenberger's avatar
Armin Rauschenberger committed
174 175 176
</div>

<div class="pkgdown">
Armin Rauschenberger's avatar
Armin Rauschenberger committed
177
  <p>Site built with <a href="https://pkgdown.r-lib.org/">pkgdown</a> 1.3.0.</p>
Armin Rauschenberger's avatar
Armin Rauschenberger committed
178 179 180 181 182 183 184 185 186
</div>
      </footer>
   </div>

  

  </body>
</html>