|
a |
|
b/docs/reference/bioTMLE-class.html |
|
|
1 |
<!-- Generated by pkgdown: do not edit by hand --> |
|
|
2 |
<!DOCTYPE html> |
|
|
3 |
<html lang="en"> |
|
|
4 |
<head> |
|
|
5 |
<meta charset="utf-8"> |
|
|
6 |
<meta http-equiv="X-UA-Compatible" content="IE=edge"> |
|
|
7 |
<meta name="viewport" content="width=device-width, initial-scale=1.0"> |
|
|
8 |
|
|
|
9 |
<title>Constructor for class bioTMLE — bioTMLE-class • biotmle</title> |
|
|
10 |
|
|
|
11 |
|
|
|
12 |
<!-- jquery --> |
|
|
13 |
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.4.1/jquery.min.js" integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></script> |
|
|
14 |
<!-- Bootstrap --> |
|
|
15 |
<link href="https://cdnjs.cloudflare.com/ajax/libs/bootswatch/3.4.0/readable/bootstrap.min.css" rel="stylesheet" crossorigin="anonymous" /> |
|
|
16 |
|
|
|
17 |
|
|
|
18 |
<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/js/bootstrap.min.js" integrity="sha256-nuL8/2cJ5NDSSwnKD8VqreErSWHtnEP9E7AySL+1ev4=" crossorigin="anonymous"></script> |
|
|
19 |
|
|
|
20 |
<!-- bootstrap-toc --> |
|
|
21 |
<link rel="stylesheet" href="../bootstrap-toc.css"> |
|
|
22 |
<script src="../bootstrap-toc.js"></script> |
|
|
23 |
|
|
|
24 |
<!-- Font Awesome icons --> |
|
|
25 |
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous" /> |
|
|
26 |
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity="sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin="anonymous" /> |
|
|
27 |
|
|
|
28 |
<!-- clipboard.js --> |
|
|
29 |
<script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script> |
|
|
30 |
|
|
|
31 |
<!-- headroom.js --> |
|
|
32 |
<script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script> |
|
|
33 |
<script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script> |
|
|
34 |
|
|
|
35 |
<!-- pkgdown --> |
|
|
36 |
<link href="../pkgdown.css" rel="stylesheet"> |
|
|
37 |
<script src="../pkgdown.js"></script> |
|
|
38 |
|
|
|
39 |
|
|
|
40 |
|
|
|
41 |
|
|
|
42 |
<meta property="og:title" content="Constructor for class bioTMLE — bioTMLE-class" /> |
|
|
43 |
<meta property="og:description" content="Constructor for class bioTMLE" /> |
|
|
44 |
|
|
|
45 |
|
|
|
46 |
|
|
|
47 |
|
|
|
48 |
<!-- mathjax --> |
|
|
49 |
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script> |
|
|
50 |
<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> |
|
|
51 |
|
|
|
52 |
<!--[if lt IE 9]> |
|
|
53 |
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script> |
|
|
54 |
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script> |
|
|
55 |
<![endif]--> |
|
|
56 |
|
|
|
57 |
|
|
|
58 |
|
|
|
59 |
</head> |
|
|
60 |
|
|
|
61 |
<body data-spy="scroll" data-target="#toc"> |
|
|
62 |
<div class="container template-reference-topic"> |
|
|
63 |
<header> |
|
|
64 |
<div class="navbar navbar-default navbar-fixed-top" role="navigation"> |
|
|
65 |
<div class="container"> |
|
|
66 |
<div class="navbar-header"> |
|
|
67 |
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false"> |
|
|
68 |
<span class="sr-only">Toggle navigation</span> |
|
|
69 |
<span class="icon-bar"></span> |
|
|
70 |
<span class="icon-bar"></span> |
|
|
71 |
<span class="icon-bar"></span> |
|
|
72 |
</button> |
|
|
73 |
<span class="navbar-brand"> |
|
|
74 |
<a class="navbar-link" href="../index.html">biotmle</a> |
|
|
75 |
<span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Released version">1.17.0</span> |
|
|
76 |
</span> |
|
|
77 |
</div> |
|
|
78 |
|
|
|
79 |
<div id="navbar" class="navbar-collapse collapse"> |
|
|
80 |
<ul class="nav navbar-nav"> |
|
|
81 |
<li> |
|
|
82 |
<a href="../index.html"> |
|
|
83 |
<span class="fas fa-home fa-lg"></span> |
|
|
84 |
|
|
|
85 |
</a> |
|
|
86 |
</li> |
|
|
87 |
<li> |
|
|
88 |
<a href="../reference/index.html">Reference</a> |
|
|
89 |
</li> |
|
|
90 |
<li class="dropdown"> |
|
|
91 |
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false"> |
|
|
92 |
Articles |
|
|
93 |
|
|
|
94 |
<span class="caret"></span> |
|
|
95 |
</a> |
|
|
96 |
<ul class="dropdown-menu" role="menu"> |
|
|
97 |
<li> |
|
|
98 |
<a href="../articles/exposureBiomarkers.html">Identifying Biomarkers from an Exposure Variable with `biotmle`</a> |
|
|
99 |
</li> |
|
|
100 |
</ul> |
|
|
101 |
</li> |
|
|
102 |
</ul> |
|
|
103 |
<ul class="nav navbar-nav navbar-right"> |
|
|
104 |
<li> |
|
|
105 |
<a href="https://github.com/nhejazi/biotmle/"> |
|
|
106 |
<span class="fab fa-github fa-lg"></span> |
|
|
107 |
|
|
|
108 |
</a> |
|
|
109 |
</li> |
|
|
110 |
</ul> |
|
|
111 |
|
|
|
112 |
</div><!--/.nav-collapse --> |
|
|
113 |
</div><!--/.container --> |
|
|
114 |
</div><!--/.navbar --> |
|
|
115 |
|
|
|
116 |
|
|
|
117 |
|
|
|
118 |
</header> |
|
|
119 |
|
|
|
120 |
<div class="row"> |
|
|
121 |
<div class="col-md-9 contents"> |
|
|
122 |
<div class="page-header"> |
|
|
123 |
<h1>Constructor for class bioTMLE</h1> |
|
|
124 |
<small class="dont-index">Source: <a href='https://github.com/nhejazi/biotmle/blob/master/R/utils.R'><code>R/utils.R</code></a></small> |
|
|
125 |
<div class="hidden name"><code>bioTMLE-class.Rd</code></div> |
|
|
126 |
</div> |
|
|
127 |
|
|
|
128 |
<div class="ref-description"> |
|
|
129 |
<p>Constructor for class bioTMLE</p> |
|
|
130 |
</div> |
|
|
131 |
|
|
|
132 |
|
|
|
133 |
|
|
|
134 |
<h2 class="hasAnchor" id="value"><a class="anchor" href="#value"></a>Value</h2> |
|
|
135 |
|
|
|
136 |
<p>class <code>biotmle</code> object, sub-classed from SummarizedExperiment.</p> |
|
|
137 |
|
|
|
138 |
<h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2> |
|
|
139 |
<pre class="examples"><div class='input'><span class='kw'><a href='https://rdrr.io/r/base/library.html'>library</a></span><span class='op'>(</span><span class='va'><a href='https://bioconductor.org/packages/SummarizedExperiment'>SummarizedExperiment</a></span><span class='op'>)</span> |
|
|
140 |
</div><div class='output co'>#> <span class='message'>Loading required package: MatrixGenerics</span></div><div class='output co'>#> <span class='message'>Loading required package: matrixStats</span></div><div class='output co'>#> <span class='message'></span> |
|
|
141 |
#> <span class='message'>Attaching package: ‘MatrixGenerics’</span></div><div class='output co'>#> <span class='message'>The following objects are masked from ‘package:matrixStats’:</span> |
|
|
142 |
#> <span class='message'></span> |
|
|
143 |
#> <span class='message'> colAlls, colAnyNAs, colAnys, colAvgsPerRowSet, colCollapse,</span> |
|
|
144 |
#> <span class='message'> colCounts, colCummaxs, colCummins, colCumprods, colCumsums,</span> |
|
|
145 |
#> <span class='message'> colDiffs, colIQRDiffs, colIQRs, colLogSumExps, colMadDiffs,</span> |
|
|
146 |
#> <span class='message'> colMads, colMaxs, colMeans2, colMedians, colMins, colOrderStats,</span> |
|
|
147 |
#> <span class='message'> colProds, colQuantiles, colRanges, colRanks, colSdDiffs, colSds,</span> |
|
|
148 |
#> <span class='message'> colSums2, colTabulates, colVarDiffs, colVars, colWeightedMads,</span> |
|
|
149 |
#> <span class='message'> colWeightedMeans, colWeightedMedians, colWeightedSds,</span> |
|
|
150 |
#> <span class='message'> colWeightedVars, rowAlls, rowAnyNAs, rowAnys, rowAvgsPerColSet,</span> |
|
|
151 |
#> <span class='message'> rowCollapse, rowCounts, rowCummaxs, rowCummins, rowCumprods,</span> |
|
|
152 |
#> <span class='message'> rowCumsums, rowDiffs, rowIQRDiffs, rowIQRs, rowLogSumExps,</span> |
|
|
153 |
#> <span class='message'> rowMadDiffs, rowMads, rowMaxs, rowMeans2, rowMedians, rowMins,</span> |
|
|
154 |
#> <span class='message'> rowOrderStats, rowProds, rowQuantiles, rowRanges, rowRanks,</span> |
|
|
155 |
#> <span class='message'> rowSdDiffs, rowSds, rowSums2, rowTabulates, rowVarDiffs, rowVars,</span> |
|
|
156 |
#> <span class='message'> rowWeightedMads, rowWeightedMeans, rowWeightedMedians,</span> |
|
|
157 |
#> <span class='message'> rowWeightedSds, rowWeightedVars</span></div><div class='output co'>#> <span class='message'>Loading required package: GenomicRanges</span></div><div class='output co'>#> <span class='message'>Loading required package: stats4</span></div><div class='output co'>#> <span class='message'>Loading required package: BiocGenerics</span></div><div class='output co'>#> <span class='message'>Loading required package: parallel</span></div><div class='output co'>#> <span class='message'></span> |
|
|
158 |
#> <span class='message'>Attaching package: ‘BiocGenerics’</span></div><div class='output co'>#> <span class='message'>The following objects are masked from ‘package:parallel’:</span> |
|
|
159 |
#> <span class='message'></span> |
|
|
160 |
#> <span class='message'> clusterApply, clusterApplyLB, clusterCall, clusterEvalQ,</span> |
|
|
161 |
#> <span class='message'> clusterExport, clusterMap, parApply, parCapply, parLapply,</span> |
|
|
162 |
#> <span class='message'> parLapplyLB, parRapply, parSapply, parSapplyLB</span></div><div class='output co'>#> <span class='message'>The following objects are masked from ‘package:stats’:</span> |
|
|
163 |
#> <span class='message'></span> |
|
|
164 |
#> <span class='message'> IQR, mad, sd, var, xtabs</span></div><div class='output co'>#> <span class='message'>The following objects are masked from ‘package:base’:</span> |
|
|
165 |
#> <span class='message'></span> |
|
|
166 |
#> <span class='message'> anyDuplicated, append, as.data.frame, basename, cbind, colnames,</span> |
|
|
167 |
#> <span class='message'> dirname, do.call, duplicated, eval, evalq, Filter, Find, get, grep,</span> |
|
|
168 |
#> <span class='message'> grepl, intersect, is.unsorted, lapply, Map, mapply, match, mget,</span> |
|
|
169 |
#> <span class='message'> order, paste, pmax, pmax.int, pmin, pmin.int, Position, rank,</span> |
|
|
170 |
#> <span class='message'> rbind, Reduce, rownames, sapply, setdiff, sort, table, tapply,</span> |
|
|
171 |
#> <span class='message'> union, unique, unsplit, which.max, which.min</span></div><div class='output co'>#> <span class='message'>Loading required package: S4Vectors</span></div><div class='output co'>#> <span class='message'></span> |
|
|
172 |
#> <span class='message'>Attaching package: ‘S4Vectors’</span></div><div class='output co'>#> <span class='message'>The following objects are masked from ‘package:base’:</span> |
|
|
173 |
#> <span class='message'></span> |
|
|
174 |
#> <span class='message'> expand.grid, I, unname</span></div><div class='output co'>#> <span class='message'>Loading required package: IRanges</span></div><div class='output co'>#> <span class='message'>Loading required package: GenomeInfoDb</span></div><div class='output co'>#> <span class='message'>Loading required package: Biobase</span></div><div class='output co'>#> <span class='message'>Welcome to Bioconductor</span> |
|
|
175 |
#> <span class='message'></span> |
|
|
176 |
#> <span class='message'> Vignettes contain introductory material; view with</span> |
|
|
177 |
#> <span class='message'> 'browseVignettes()'. To cite Bioconductor, see</span> |
|
|
178 |
#> <span class='message'> 'citation("Biobase")', and for packages 'citation("pkgname")'.</span></div><div class='output co'>#> <span class='message'></span> |
|
|
179 |
#> <span class='message'>Attaching package: ‘Biobase’</span></div><div class='output co'>#> <span class='message'>The following object is masked from ‘package:MatrixGenerics’:</span> |
|
|
180 |
#> <span class='message'></span> |
|
|
181 |
#> <span class='message'> rowMedians</span></div><div class='output co'>#> <span class='message'>The following objects are masked from ‘package:matrixStats’:</span> |
|
|
182 |
#> <span class='message'></span> |
|
|
183 |
#> <span class='message'> anyMissing, rowMedians</span></div><div class='input'><span class='kw'><a href='https://rdrr.io/r/base/library.html'>library</a></span><span class='op'>(</span><span class='va'>biotmleData</span><span class='op'>)</span> |
|
|
184 |
<span class='fu'><a href='https://rdrr.io/r/utils/data.html'>data</a></span><span class='op'>(</span><span class='va'>illuminaData</span><span class='op'>)</span> |
|
|
185 |
|
|
|
186 |
<span class='va'>example_biotmle_class</span> <span class='op'><-</span> <span class='kw'>function</span><span class='op'>(</span><span class='va'>se</span><span class='op'>)</span> <span class='op'>{</span> |
|
|
187 |
<span class='va'>call</span> <span class='op'><-</span> <span class='fu'><a href='https://rdrr.io/r/base/match.call.html'>match.call</a></span><span class='op'>(</span>expand.dots <span class='op'>=</span> <span class='cn'>TRUE</span><span class='op'>)</span> |
|
|
188 |
<span class='va'>biotmle</span> <span class='op'><-</span> <span class='fu'>.biotmle</span><span class='op'>(</span> |
|
|
189 |
<span class='fu'><a href='https://rdrr.io/pkg/SummarizedExperiment/man/RangedSummarizedExperiment-class.html'>SummarizedExperiment</a></span><span class='op'>(</span> |
|
|
190 |
assays <span class='op'>=</span> <span class='fu'><a href='https://rdrr.io/pkg/SummarizedExperiment/man/SummarizedExperiment-class.html'>assay</a></span><span class='op'>(</span><span class='va'>se</span><span class='op'>)</span>, |
|
|
191 |
rowData <span class='op'>=</span> <span class='fu'><a href='https://rdrr.io/pkg/SummarizedExperiment/man/SummarizedExperiment-class.html'>rowData</a></span><span class='op'>(</span><span class='va'>se</span><span class='op'>)</span>, |
|
|
192 |
colData <span class='op'>=</span> <span class='fu'><a href='https://rdrr.io/pkg/SummarizedExperiment/man/SummarizedExperiment-class.html'>colData</a></span><span class='op'>(</span><span class='va'>se</span><span class='op'>)</span> |
|
|
193 |
<span class='op'>)</span>, |
|
|
194 |
call <span class='op'>=</span> <span class='va'>call</span>, |
|
|
195 |
ateOut <span class='op'>=</span> <span class='fu'><a href='https://rdrr.io/r/base/numeric.html'>as.numeric</a></span><span class='op'>(</span><span class='fu'><a href='https://rdrr.io/r/base/rep.html'>rep</a></span><span class='op'>(</span><span class='cn'>NA</span>, <span class='fl'>10</span><span class='op'>)</span><span class='op'>)</span>, |
|
|
196 |
tmleOut <span class='op'>=</span> <span class='fu'><a href='https://rdrr.io/r/base/as.data.frame.html'>as.data.frame</a></span><span class='op'>(</span><span class='fu'><a href='https://rdrr.io/r/base/matrix.html'>matrix</a></span><span class='op'>(</span><span class='cn'>NA</span>, <span class='fl'>10</span>, <span class='fl'>10</span><span class='op'>)</span><span class='op'>)</span>, |
|
|
197 |
topTable <span class='op'>=</span> <span class='fu'><a href='https://rdrr.io/r/base/as.data.frame.html'>as.data.frame</a></span><span class='op'>(</span><span class='fu'><a href='https://rdrr.io/r/base/matrix.html'>matrix</a></span><span class='op'>(</span><span class='cn'>NA</span>, <span class='fl'>10</span>, <span class='fl'>10</span><span class='op'>)</span><span class='op'>)</span> |
|
|
198 |
<span class='op'>)</span> |
|
|
199 |
<span class='kw'><a href='https://rdrr.io/r/base/function.html'>return</a></span><span class='op'>(</span><span class='va'>biotmle</span><span class='op'>)</span> |
|
|
200 |
<span class='op'>}</span> |
|
|
201 |
|
|
|
202 |
<span class='va'>example_class</span> <span class='op'><-</span> <span class='fu'>example_biotmle_class</span><span class='op'>(</span>se <span class='op'>=</span> <span class='va'>illuminaData</span><span class='op'>)</span> |
|
|
203 |
</div></pre> |
|
|
204 |
</div> |
|
|
205 |
<div class="col-md-3 hidden-xs hidden-sm" id="pkgdown-sidebar"> |
|
|
206 |
<nav id="toc" data-toggle="toc" class="sticky-top"> |
|
|
207 |
<h2 data-toc-skip>Contents</h2> |
|
|
208 |
</nav> |
|
|
209 |
</div> |
|
|
210 |
</div> |
|
|
211 |
|
|
|
212 |
|
|
|
213 |
<footer> |
|
|
214 |
<div class="copyright"> |
|
|
215 |
<p>Developed by Nima Hejazi, Alan Hubbard, Mark van der Laan.</p> |
|
|
216 |
</div> |
|
|
217 |
|
|
|
218 |
<div class="pkgdown"> |
|
|
219 |
<p>Site built with <a href="https://pkgdown.r-lib.org/">pkgdown</a> 1.6.1.</p> |
|
|
220 |
</div> |
|
|
221 |
|
|
|
222 |
</footer> |
|
|
223 |
</div> |
|
|
224 |
|
|
|
225 |
|
|
|
226 |
|
|
|
227 |
|
|
|
228 |
</body> |
|
|
229 |
</html> |
|
|
230 |
|
|
|
231 |
|