-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.html
455 lines (420 loc) · 29.6 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
<!doctype html>
<html class="no-js" lang="en" data-content_root="./">
<head><meta charset="utf-8"/>
<meta name="viewport" content="width=device-width,initial-scale=1"/>
<meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta property="og:title" content="Biolearn" />
<meta property="og:type" content="website" />
<meta property="og:url" content="https://bio-learn.github.io/index.html" />
<meta property="og:site_name" content="Biolearn" />
<meta property="og:description" content="Biolearn enables easy and versatile analyses of biomarkers of aging data. It provides tools to easily load data from publicly available sources like the Gene Expression Omnibus, National Health and..." />
<meta property="og:image" content="https://bio-learn.github.io/_images/sphx_glr_plot_epigenetic_clocks_on_geo_001.png" />
<meta property="og:image:alt" content="Biolearn" />
<meta name="description" content="Biolearn enables easy and versatile analyses of biomarkers of aging data. It provides tools to easily load data from publicly available sources like the Gene Expression Omnibus, National Health and..." />
<link rel="search" title="Search" href="search.html" /><link rel="next" title="Quickstart" href="quickstart.html" />
<link rel="shortcut icon" href="_static/favicon.ico"/><!-- Generated with Sphinx 7.2.6 and Furo 2024.01.29 -->
<title>Biolearn</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=045299b1" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=135e06be" />
<link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery.css?v=61a4c737" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-binder.css?v=f4aeca0c" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-dataframe.css?v=2082cf3c" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-rendered-html.css?v=1277b6f3" />
<link rel="stylesheet" type="text/css" href="_static/design-style.1e8bd061cd6da7fc9cf755528e8ffc24.min.css?v=0a3b3ea7" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?v=36a5483c" />
<link rel="stylesheet" type="text/css" href="_static/custom.css?v=b603f989" />
<link rel="stylesheet" type="text/css" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/all.min.css" />
<style>
body {
--color-code-background: #ffffff;
--color-code-foreground: black;
--admonition-font-size: 100%;
--admonition-title-font-size: 100%;
--color-announcement-background: #FBB360;
--color-announcement-text: #111418;
--color-admonition-title--note: #448aff;
--color-admonition-title-background--note: #448aff10;
}
@media not print {
body[data-theme="dark"] {
--color-code-background: #232629;
--color-code-foreground: #cccccc;
--color-announcement-background: #935610;
--color-announcement-text: #FFFFFF;
}
@media (prefers-color-scheme: dark) {
body:not([data-theme="light"]) {
--color-code-background: #232629;
--color-code-foreground: #cccccc;
--color-announcement-background: #935610;
--color-announcement-text: #FFFFFF;
}
}
}
</style></head>
<body>
<script>
document.body.dataset.theme = localStorage.getItem("theme") || "auto";
</script>
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
<symbol id="svg-toc" viewBox="0 0 24 24">
<title>Contents</title>
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
<path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
</svg>
</symbol>
<symbol id="svg-menu" viewBox="0 0 24 24">
<title>Menu</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
<line x1="3" y1="12" x2="21" y2="12"></line>
<line x1="3" y1="6" x2="21" y2="6"></line>
<line x1="3" y1="18" x2="21" y2="18"></line>
</svg>
</symbol>
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
<title>Expand</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
<polyline points="9 18 15 12 9 6"></polyline>
</svg>
</symbol>
<symbol id="svg-sun" viewBox="0 0 24 24">
<title>Light mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
<circle cx="12" cy="12" r="5"></circle>
<line x1="12" y1="1" x2="12" y2="3"></line>
<line x1="12" y1="21" x2="12" y2="23"></line>
<line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
<line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
<line x1="1" y1="12" x2="3" y2="12"></line>
<line x1="21" y1="12" x2="23" y2="12"></line>
<line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
<line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
</svg>
</symbol>
<symbol id="svg-moon" viewBox="0 0 24 24">
<title>Dark mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
<path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
</svg>
</symbol>
<symbol id="svg-sun-half" viewBox="0 0 24 24">
<title>Auto light/dark mode</title>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
<path stroke="none" d="M0 0h24v24H0z" fill="none"/>
<circle cx="12" cy="12" r="9" />
<path d="M13 12h5" />
<path d="M13 15h4" />
<path d="M13 18h1" />
<path d="M13 9h4" />
<path d="M13 6h1" />
</svg>
</symbol>
</svg>
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
<label class="overlay sidebar-overlay" for="__navigation">
<div class="visually-hidden">Hide navigation sidebar</div>
</label>
<label class="overlay toc-overlay" for="__toc">
<div class="visually-hidden">Hide table of contents sidebar</div>
</label>
<div class="page">
<header class="mobile-header">
<div class="header-left">
<label class="nav-overlay-icon" for="__navigation">
<div class="visually-hidden">Toggle site navigation sidebar</div>
<i class="icon"><svg><use href="#svg-menu"></use></svg></i>
</label>
</div>
<div class="header-center">
<a href="#"><div class="brand">Biolearn</div></a>
</div>
<div class="header-right">
<div class="theme-toggle-container theme-toggle-header">
<button class="theme-toggle">
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
</button>
</div>
<label class="toc-overlay-icon toc-header-icon" for="__toc">
<div class="visually-hidden">Toggle table of contents sidebar</div>
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
</label>
</div>
</header>
<aside class="sidebar-drawer">
<div class="sidebar-container">
<div class="sidebar-sticky"><a class="sidebar-brand" href="#">
<div class="sidebar-logo-container">
<img class="sidebar-logo" src="_static/biolearn-transparent.png" alt="Logo"/>
</div>
<span class="sidebar-brand-text">Biolearn</span>
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
<input type="hidden" name="check_keywords" value="yes">
<input type="hidden" name="area" value="default">
</form>
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
<ul>
<li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quickstart</a></li>
<li class="toctree-l1"><a class="reference internal" href="clocks.html">Clocks and Other Models</a></li>
<li class="toctree-l1"><a class="reference internal" href="data.html">GEO Data Sources</a></li>
<li class="toctree-l1"><a class="reference internal" href="methylation-standard.html">DNA Methylation Array Data Standard V-2410</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="auto_examples/index.html">Examples</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Examples</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l2 has-children"><a class="reference internal" href="auto_examples/00_omics_biomarkers/index.html">Omics Biomarker Examples</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of Omics Biomarker Examples</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="auto_examples/00_omics_biomarkers/plot_local_data_load.html">Local Data Loading</a></li>
<li class="toctree-l3"><a class="reference internal" href="auto_examples/00_omics_biomarkers/plot_transcriptomic_clock.html">“Transcriptomic Clock” using GEO Data</a></li>
<li class="toctree-l3"><a class="reference internal" href="auto_examples/00_omics_biomarkers/plot_epigenetic_clocks_on_geo.html">“Epigenetic Clocks” in GEO Data</a></li>
<li class="toctree-l3"><a class="reference internal" href="auto_examples/00_omics_biomarkers/plot_down_syndrome_model.html">Down Syndrome Epigenetic Plotting</a></li>
<li class="toctree-l3"><a class="reference internal" href="auto_examples/00_omics_biomarkers/plot_custom_imputation_implementation.html">Performing custom imputations</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="auto_examples/01_composite_biomarkers/index.html">Composite Biomarkers Examples</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><div class="visually-hidden">Toggle navigation of Composite Biomarkers Examples</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="auto_examples/01_composite_biomarkers/plot_nhanes.html">“Phenotypic Ages” in NHANES Data</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="auto_examples/02_challenge_submissions/index.html">Challenge Submission Examples</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" role="switch" type="checkbox"/><label for="toctree-checkbox-4"><div class="visually-hidden">Toggle navigation of Challenge Submission Examples</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="auto_examples/02_challenge_submissions/simple_competiton_submission.html">Building a competition submission using an existing model</a></li>
<li class="toctree-l3"><a class="reference internal" href="auto_examples/02_challenge_submissions/plot_challenge_data.html">Exploring the Challenge Data</a></li>
<li class="toctree-l3"><a class="reference internal" href="auto_examples/02_challenge_submissions/training_simple_model.html">Training an ElasticNet model</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="auto_examples/03_deconvolution/index.html">Deconvolution Examples</a><input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" role="switch" type="checkbox"/><label for="toctree-checkbox-5"><div class="visually-hidden">Toggle navigation of Deconvolution Examples</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="auto_examples/03_deconvolution/plot_blood_deconvolution.html">“Deconvolution Example”</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1 has-children"><a class="reference internal" href="modules/index.html">API References</a><input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" role="switch" type="checkbox"/><label for="toctree-checkbox-6"><div class="visually-hidden">Toggle navigation of API References</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l2 has-children"><a class="reference internal" href="modules/data_library.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">biolearn.data_library</span></code>: DataLibrary</a><input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" role="switch" type="checkbox"/><label for="toctree-checkbox-7"><div class="visually-hidden">Toggle navigation of biolearn.data_library: DataLibrary</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="modules/generated/biolearn.data_library.DataLibrary.html">biolearn.data_library.DataLibrary</a></li>
<li class="toctree-l3"><a class="reference internal" href="modules/generated/biolearn.data_library.DataSource.html">biolearn.data_library.DataSource</a></li>
<li class="toctree-l3"><a class="reference internal" href="modules/generated/biolearn.data_library.GeoData.html">biolearn.data_library.GeoData</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="modules/model_gallery.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">biolearn.model_gallery</span></code>: ModelGallery</a><input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" role="switch" type="checkbox"/><label for="toctree-checkbox-8"><div class="visually-hidden">Toggle navigation of biolearn.model_gallery: ModelGallery</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="modules/generated/biolearn.model_gallery.ModelGallery.html">biolearn.model_gallery.ModelGallery</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="modules/cache.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">biolearn.cache</span></code>: Cache</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle navigation of biolearn.cache: Cache</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="modules/generated/biolearn.cache.NoCache.html">biolearn.cache.NoCache</a></li>
<li class="toctree-l3"><a class="reference internal" href="modules/generated/biolearn.cache.LocalFolderCache.html">biolearn.cache.LocalFolderCache</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="modules/imputation.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">biolearn.imputation</span></code>: Data Imputation Functions</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><div class="visually-hidden">Toggle navigation of biolearn.imputation: Data Imputation Functions</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="modules/generated/biolearn.imputation.impute_from_standard.html">biolearn.imputation.impute_from_standard</a></li>
<li class="toctree-l3"><a class="reference internal" href="modules/generated/biolearn.imputation.impute_from_average.html">biolearn.imputation.impute_from_average</a></li>
<li class="toctree-l3"><a class="reference internal" href="modules/generated/biolearn.imputation.hybrid_impute.html">biolearn.imputation.hybrid_impute</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="modules/mortality.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">biolearn.mortality</span></code>: Mortality Predictor Evaluation</a><input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" role="switch" type="checkbox"/><label for="toctree-checkbox-11"><div class="visually-hidden">Toggle navigation of biolearn.mortality: Mortality Predictor Evaluation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="modules/generated/biolearn.mortality.run_predictions.html">biolearn.mortality.run_predictions</a></li>
<li class="toctree-l3"><a class="reference internal" href="modules/generated/biolearn.mortality.calculate_c_index.html">biolearn.mortality.calculate_c_index</a></li>
<li class="toctree-l3"><a class="reference internal" href="modules/generated/biolearn.mortality.calculate_mortality_hazard_ratios.html">biolearn.mortality.calculate_mortality_hazard_ratios</a></li>
<li class="toctree-l3"><a class="reference internal" href="modules/generated/biolearn.mortality.calculate_age_adjusted_c_index.html">biolearn.mortality.calculate_age_adjusted_c_index</a></li>
<li class="toctree-l3"><a class="reference internal" href="modules/generated/biolearn.mortality.calculate_log_rank_test.html">biolearn.mortality.calculate_log_rank_test</a></li>
<li class="toctree-l3"><a class="reference internal" href="modules/generated/biolearn.mortality.plot_hazard_ratios.html">biolearn.mortality.plot_hazard_ratios</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="modules/load.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">biolearn.load</span></code>: Data Loading Utilities</a><input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" role="switch" type="checkbox"/><label for="toctree-checkbox-12"><div class="visually-hidden">Toggle navigation of biolearn.load: Data Loading Utilities</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="modules/generated/biolearn.load.load_nhanes.html">biolearn.load.load_nhanes</a></li>
<li class="toctree-l3"><a class="reference internal" href="modules/generated/biolearn.load.load_fhs.html">biolearn.load.load_fhs</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Development</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="authors.html">Team</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/bio-learn/biolearn">GitHub Repository</a></li>
</ul>
</div>
</div>
</div>
</div>
</aside>
<div class="main">
<div class="content">
<div class="article-container">
<a href="#" class="back-to-top muted-link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
<path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
</svg>
<span>Back to top</span>
</a>
<div class="content-icon-container">
<div class="theme-toggle-container theme-toggle-content">
<button class="theme-toggle">
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
</button>
</div>
<label class="toc-overlay-icon toc-content-icon" for="__toc">
<div class="visually-hidden">Toggle table of contents sidebar</div>
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
</label>
</div>
<article role="main">
<section id="biolearn">
<h1>Biolearn<a class="headerlink" href="#biolearn" title="Link to this heading">#</a></h1>
<p>Biolearn enables easy and versatile analyses of biomarkers of aging data. It provides tools to easily load data from publicly available sources like the
<a class="reference external" href="https://www.ncbi.nlm.nih.gov/geo/">Gene Expression Omnibus</a>, <a class="reference external" href="https://www.cdc.gov/nchs/nhanes/index.htm">National Health and Nutrition Examination Survey</a>,
and the <a class="reference external" href="https://www.framinghamheartstudy.org/">Framingham Heart Study</a>. Biolearn also contains reference implementations for common aging clocks such as the
Horvath clock, DunedinPACE, and many others that can easily be run in only a few lines of code. You can read more about it in our <a class="reference external" href="https://www.biorxiv.org/content/10.1101/2023.12.02.569722v2">paper</a>.</p>
<p>Biolearn is developed and supported by several organizations and individuals, especially <a class="reference external" href="https://www.agingconsortium.org/">Biomarkers of Aging Consortium</a>,
<a class="reference external" href="https://www.mfoundation.org/">Methuselah Foundation</a>, and <a class="reference external" href="https://www.VOLOfoundation.org/">VOLO Foundation</a>.</p>
<p>We are hosting a 2024-2025 Challenge series on the Synapse platform, where participants will be asked to predict chronological age,
mortality, and multi-morbidity, with total awards of $200k+. <a class="reference external" href="https://www.synapse.org/#!Synapse:syn52966292/wiki/624696/">Learn more at Synapse!</a>.</p>
<p>If you use Biolearn in your research, please cite our <a class="reference external" href="https://doi.org/10.1101/2023.12.02.569722">preprint</a>:</p>
<p>Ying, K., Paulson, S., Perez-Guevara, M., Emamifar, M., Martí nez, M. C., Kwon, D., Poganik, J. R., Moqri, M., & Gladyshev, V. N. (2023). Biolearn, an open-source library for biomarkers of aging. bioRxiv. <a class="reference external" href="https://doi.org/10.1101/2023.12.02.569722">https://doi.org/10.1101/2023.12.02.569722</a></p>
<div class="sd-container-fluid sd-sphinx-override sd-mb-4 docutils">
<div class="sd-row docutils">
<div class="sd-col sd-d-flex-row sd-col-12 sd-col-xs-12 sd-col-sm-12 sd-col-md-4 sd-col-lg-4 sd-mt-2 sd-mb-2 sd-ml-0 sd-mr-0 docutils">
<div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-card-hover sd-shadow-md docutils">
<div class="sd-card-body docutils">
<div class="sd-card-title sd-font-weight-bold sd-text-primary docutils">
<span class="fas fa-rocket"></span> Quickstart</div>
<p class="sd-card-text">Get started with Biolearn</p>
</div>
<a class="sd-stretched-link reference internal" href="quickstart.html#quickstart"><span class="std std-ref"></span></a></div>
</div>
<div class="sd-col sd-d-flex-row sd-col-12 sd-col-xs-12 sd-col-sm-12 sd-col-md-4 sd-col-lg-4 sd-mt-2 sd-mb-2 sd-ml-0 sd-mr-0 docutils">
<div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-card-hover sd-shadow-md docutils">
<div class="sd-card-body docutils">
<div class="sd-card-title sd-font-weight-bold sd-text-primary docutils">
<span class="fas fa-road"></span> Roadmap</div>
<p class="sd-card-text">See where Biolearn is headed and how to contribute</p>
</div>
<a class="sd-stretched-link reference external" href="roadmap.html"></a></div>
</div>
<div class="sd-col sd-d-flex-row sd-col-12 sd-col-xs-12 sd-col-sm-12 sd-col-md-4 sd-col-lg-4 sd-mt-2 sd-mb-2 sd-ml-0 sd-mr-0 docutils">
<div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-card-hover sd-shadow-md docutils">
<div class="sd-card-body docutils">
<div class="sd-card-title sd-font-weight-bold sd-text-primary docutils">
<span class="fas fa-trophy"></span> Challenge</div>
<p class="sd-card-text">Join the Biomarkers of Aging Challenge!</p>
</div>
<a class="sd-stretched-link reference external" href="https://www.synapse.org/#!Synapse:syn52966292/"></a></div>
</div>
</div>
</div>
<section id="featured-examples">
<h2>Featured examples<a class="headerlink" href="#featured-examples" title="Link to this heading">#</a></h2>
<div class="sd-container-fluid sd-sphinx-override sd-mb-4 docutils">
<div class="sd-row docutils">
<div class="sd-col sd-d-flex-row sd-col-12 sd-col-xs-12 sd-col-sm-12 sd-col-md-12 sd-col-lg-12 sd-mt-2 sd-mb-2 sd-ml-auto sd-mr-auto docutils">
<div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-card-hover docutils">
<div class="sd-card-body docutils">
<div class="sd-container-fluid sd-sphinx-override sd-m-0 sd-p-0 docutils">
<div class="sd-row sd-g-3 sd-g-xs-3 sd-g-sm-3 sd-g-md-3 sd-g-lg-3 docutils">
<div class="sd-col sd-d-flex-column sd-col-12 sd-col-xs-12 sd-col-sm-4 sd-col-md-4 sd-col-lg-4 docutils">
<img alt="_images/sphx_glr_plot_epigenetic_clocks_on_geo_001.png" src="_images/sphx_glr_plot_epigenetic_clocks_on_geo_001.png" />
</div>
<div class="sd-col sd-d-flex-column sd-col-12 sd-col-xs-12 sd-col-sm-8 sd-col-md-8 sd-col-lg-8 docutils">
<div class="sd-font-weight-bold docutils">
<p class="sd-card-text">Demonstrate computation of several epigenetic clocks</p>
</div>
<p class="sd-card-text">Show how the clocks compare with chronological age</p>
</div>
</div>
</div>
</div>
<a class="sd-stretched-link reference external" href="auto_examples/00_omics_biomarkers/plot_epigenetic_clocks_on_geo.html"></a></div>
</div>
<div class="sd-col sd-d-flex-row sd-col-12 sd-col-xs-12 sd-col-sm-12 sd-col-md-12 sd-col-lg-12 sd-mt-2 sd-mb-2 sd-ml-auto sd-mr-auto docutils">
<div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-card-hover docutils">
<div class="sd-card-body docutils">
<div class="sd-container-fluid sd-sphinx-override sd-m-0 sd-p-0 docutils">
<div class="sd-row sd-g-3 sd-g-xs-3 sd-g-sm-3 sd-g-md-3 sd-g-lg-3 docutils">
<div class="sd-col sd-d-flex-column sd-col-12 sd-col-xs-12 sd-col-sm-4 sd-col-md-4 sd-col-lg-4 docutils">
<img alt="_images/sphx_glr_plot_nhanes_002.png" src="_images/sphx_glr_plot_nhanes_002.png" />
</div>
<div class="sd-col sd-d-flex-column sd-col-12 sd-col-xs-12 sd-col-sm-8 sd-col-md-8 sd-col-lg-8 docutils">
<div class="sd-font-weight-bold docutils">
<p class="sd-card-text">NHANES survival plotting with biological age</p>
</div>
<p class="sd-card-text">Using NHANES data shows relationship between various data points and survival</p>
</div>
</div>
</div>
</div>
<a class="sd-stretched-link reference external" href="auto_examples/01_composite_biomarkers/plot_nhanes.html"></a></div>
</div>
</div>
</div>
<div class="toctree-wrapper compound">
</div>
<div class="toctree-wrapper compound">
</div>
</section>
</section>
</article>
</div>
<footer>
<div class="related-pages">
<a class="next-page" href="quickstart.html">
<div class="page-info">
<div class="context">
<span>Next</span>
</div>
<div class="title">Quickstart</div>
</div>
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
</a>
</div>
<div class="bottom-of-page">
<div class="left-details">
<div class="copyright">
Copyright © The biolearn developers 2023-2024
</div>
Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
<a href="https://github.com/pradyunsg/furo">Furo</a>
</div>
<div class="right-details">
</div>
</div>
</footer>
</div>
<aside class="toc-drawer">
<div class="toc-sticky toc-scroll">
<div class="toc-title-container">
<span class="toc-title">
On this page
</span>
</div>
<div class="toc-tree-container">
<div class="toc-tree">
<ul>
<li><a class="reference internal" href="#">Biolearn</a><ul>
<li><a class="reference internal" href="#featured-examples">Featured examples</a><ul>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</aside>
</div>
</div><script src="_static/documentation_options.js?v=5929fcd5"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/scripts/furo.js?v=32e29ea5"></script>
<script src="_static/clipboard.min.js?v=a7894cd8"></script>
<script src="_static/copybutton.js?v=4ea706d9"></script>
<script src="_static/design-tabs.js?v=36754332"></script>
</body>
</html>