coef.cornet.html 6.19 KB
Newer Older
Armin Rauschenberger's avatar
Armin Rauschenberger committed
1
2
3
4
5
6
7
8
<!-- Generated by pkgdown: do not edit by hand -->
<!DOCTYPE html>
<html>
  <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
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

<!-- jquery -->
<script src="https://code.jquery.com/jquery-3.1.0.min.js" integrity="sha384-nrOSfDHtoPMzJHjVTdCopGqIqeYETSXhZDFyniQ8ZHcVy08QesyHcnOUpMpqnmWq" crossorigin="anonymous"></script>
<!-- Bootstrap -->

<link href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" crossorigin="anonymous">
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script>

<!-- Font Awesome icons -->
<link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.6.3/css/font-awesome.min.css" rel="stylesheet" integrity="sha384-T8Gy5hrqNKT+hzMclPo118YTQO6cYprQmhrYwIiQ/3axmI1hQomh7Ud2hPOy8SP1" crossorigin="anonymous">

<!-- clipboard.js -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/1.7.1/clipboard.min.js" integrity="sha384-cV+rhyOuRHc9Ub/91rihWcGmMmCXDeksTtCihMupQHSsi8GIIRDG0ThDc3HGQFJ3" crossorigin="anonymous"></script>

<!-- 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
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
<meta name="twitter:card" content="summary" />



<!-- mathjax -->
<script src='https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></script>

<!--[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">
      <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar">
        <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
64
        <a class="navbar-link" href="../index.html">cornet</a>
Armin Rauschenberger's avatar
Armin Rauschenberger committed
65
        <span class="label label-default" data-toggle="tooltip" data-placement="bottom" title="Released package">0.0.1</span>
Armin Rauschenberger's avatar
Armin Rauschenberger committed
66
67
68
69
70
71
72
73
74
75
76
77
78
79
      </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
80
81
82
83
84
85
86
87
88
89
90
91
<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
92
93
94
95
96
97
98
<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
99
  <a href="https://github.com/rauschenberger/cornet">
Armin Rauschenberger's avatar
Armin Rauschenberger committed
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
    <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
116
    <h1>Extract estimated coefficients</h1>
Armin Rauschenberger's avatar
Armin Rauschenberger committed
117
    <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
118
    <div class="hidden name"><code>coef.cornet.Rd</code></div>
Armin Rauschenberger's avatar
Armin Rauschenberger committed
119
120
121
122
    </div>

    <div class="ref-description">
    
Armin Rauschenberger's avatar
Armin Rauschenberger committed
123
124
    <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
125
126
127
    
    </div>

Armin Rauschenberger's avatar
Armin Rauschenberger committed
128
    <pre class="usage"><span class='co'># S3 method for cornet</span>
Armin Rauschenberger's avatar
Armin Rauschenberger committed
129
130
131
132
133
134
135
<span class='fu'>coef</span>(<span class='no'>object</span>, <span class='no'>...</span>)</pre>
    
    <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
136
      <td><p><a href='cornet.html'>cornet</a> object</p></td>
Armin Rauschenberger's avatar
Armin Rauschenberger committed
137
138
139
    </tr>
    <tr>
      <th>...</th>
Armin Rauschenberger's avatar
Armin Rauschenberger committed
140
      <td><p>further arguments (not applicable)</p></td>
Armin Rauschenberger's avatar
Armin Rauschenberger committed
141
142
143
    </tr>
    </table>
    
Armin Rauschenberger's avatar
Armin Rauschenberger committed
144
145
146
147
148
149
150
    <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
151
152
153
154
155
156
157
158
159

    <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
160
161
162
      
      <li><a href="#value">Value</a></li>
      
Armin Rauschenberger's avatar
Armin Rauschenberger committed
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
      <li><a href="#examples">Examples</a></li>
    </ul>

  </div>
</div>

      <footer>
      <div class="copyright">
  <p>Developed by Armin Rauschenberger.</p>
</div>

<div class="pkgdown">
  <p>Site built with <a href="http://pkgdown.r-lib.org/">pkgdown</a>.</p>
</div>

      </footer>
   </div>

  

  </body>
</html>