coef.cornet.html 6.56 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 estimated coefficients — coef.cornet • cornet</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
14
<!-- Bootstrap -->

Armin Rauschenberger's avatar
Armin Rauschenberger committed
15
16
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/css/bootstrap.min.css" integrity="sha256-916EbMg70RQy9LHiGkXzG8hSg9EdNy97GazNG/aiY1w=" crossorigin="anonymous" />
<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 estimated coefficients — coef.cornet" />
Armin Rauschenberger's avatar
Armin Rauschenberger committed
34

Armin Rauschenberger's avatar
Armin Rauschenberger committed
35
36
<meta property="og:description" content="Extracts estimated coefficients from linear and logistic regression,
under the penalty parameter that minimises the cross-validated loss." />
Armin Rauschenberger's avatar
Armin Rauschenberger committed
37
38
39
40
41
<meta name="twitter:card" content="summary" />



<!-- mathjax -->
Armin Rauschenberger's avatar
Armin Rauschenberger committed
42
43
<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
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58

<!--[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
59
60
      <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
61
62
63
64
65
        <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
66
        <a class="navbar-link" href="../index.html">cornet</a>
Armin Rauschenberger's avatar
Armin Rauschenberger committed
67
        <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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
      </span>
    </div>

    <div id="navbar" class="navbar-collapse collapse">
      <ul class="nav navbar-nav">
        <li>
  <a href="../index.html">
    <span class="fa fa-home fa-lg"></span>
     
  </a>
</li>
<li>
  <a href="../reference/index.html">Reference</a>
</li>
Armin Rauschenberger's avatar
Armin Rauschenberger committed
82
83
84
85
86
87
88
89
90
91
92
93
<li class="dropdown">
  <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">
    Articles
     
    <span class="caret"></span>
  </a>
  <ul class="dropdown-menu" role="menu">
    <li>
      <a href="../articles/vignette.html">Lasso and ridge regression for dichotomised outcomes</a>
    </li>
  </ul>
</li>
Armin Rauschenberger's avatar
Armin Rauschenberger committed
94
95
96
97
98
99
100
<li>
  <a href="../news/index.html">Changelog</a>
</li>
      </ul>
      
      <ul class="nav navbar-nav navbar-right">
        <li>
Armin Rauschenberger's avatar
Armin Rauschenberger committed
101
  <a href="https://github.com/rauschenberger/cornet">
Armin Rauschenberger's avatar
Armin Rauschenberger committed
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
    <span class="fa fa-github fa-lg"></span>
     
  </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
118
    <h1>Extract estimated coefficients</h1>
Armin Rauschenberger's avatar
Armin Rauschenberger committed
119
    <small class="dont-index">Source: <a href='https://github.com/rauschenberger/cornet/blob/master/R/functions.R'><code>R/functions.R</code></a></small>
Armin Rauschenberger's avatar
Armin Rauschenberger committed
120
    <div class="hidden name"><code>coef.cornet.Rd</code></div>
Armin Rauschenberger's avatar
Armin Rauschenberger committed
121
122
123
124
    </div>

    <div class="ref-description">
    
Armin Rauschenberger's avatar
Armin Rauschenberger committed
125
126
    <p>Extracts estimated coefficients from linear and logistic regression,
under the penalty parameter that minimises the cross-validated loss.</p>
Armin Rauschenberger's avatar
Armin Rauschenberger committed
127
128
129
    
    </div>

Armin Rauschenberger's avatar
Armin Rauschenberger committed
130
    <pre class="usage"><span class='co'># S3 method for cornet</span>
Armin Rauschenberger's avatar
Armin Rauschenberger committed
131
<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
132
133
134
135
136
137
    
    <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>
      <th>object</th>
Armin Rauschenberger's avatar
Armin Rauschenberger committed
138
      <td><p>cornet object</p></td>
Armin Rauschenberger's avatar
Armin Rauschenberger committed
139
140
141
    </tr>
    <tr>
      <th>...</th>
Armin Rauschenberger's avatar
Armin Rauschenberger committed
142
      <td><p>further arguments (not applicable)</p></td>
Armin Rauschenberger's avatar
Armin Rauschenberger committed
143
144
145
    </tr>
    </table>
    
Armin Rauschenberger's avatar
Armin Rauschenberger committed
146
147
148
149
150
151
152
    <h2 class="hasAnchor" id="value"><a class="anchor" href="#value"></a>Value</h2>

    <p>This function returns a matrix with \(n\) rows and two columns,
where \(n\) is the sample size. It includes the estimated coefficients
from linear (first column, <code>"beta"</code>)
and logistic (second column, <code>"gamma"</code>) regression.</p>
    
Armin Rauschenberger's avatar
Armin Rauschenberger committed
153
154
155
156
157
158
159
160
161

    <h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2>
    <pre class="examples"><div class='input'><span class='fl'>NA</span></div><div class='output co'>#&gt; [1] NA</div><div class='input'>
</div></pre>
  </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
173
174
175
176
      <li><a href="#examples">Examples</a></li>
    </ul>

  </div>
</div>

      <footer>
      <div class="copyright">
  <p>Developed by Armin Rauschenberger.</p>
</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>