-
Notifications
You must be signed in to change notification settings - Fork 5
/
Copy pathREADME.html
297 lines (279 loc) · 15.5 KB
/
README.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
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
<meta charset="utf-8">
<meta name="generator" content="quarto-1.2.269">
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
<title>readme</title>
<style>
code{white-space: pre-wrap;}
span.smallcaps{font-variant: small-caps;}
div.columns{display: flex; gap: min(4vw, 1.5em);}
div.column{flex: auto; overflow-x: auto;}
div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;}
ul.task-list{list-style: none;}
ul.task-list li input[type="checkbox"] {
width: 0.8em;
margin: 0 0.8em 0.2em -1.6em;
vertical-align: middle;
}
pre > code.sourceCode { white-space: pre; position: relative; }
pre > code.sourceCode > span { display: inline-block; line-height: 1.25; }
pre > code.sourceCode > span:empty { height: 1.2em; }
.sourceCode { overflow: visible; }
code.sourceCode > span { color: inherit; text-decoration: inherit; }
div.sourceCode { margin: 1em 0; }
pre.sourceCode { margin: 0; }
@media screen {
div.sourceCode { overflow: auto; }
}
@media print {
pre > code.sourceCode { white-space: pre-wrap; }
pre > code.sourceCode > span { text-indent: -5em; padding-left: 5em; }
}
pre.numberSource code
{ counter-reset: source-line 0; }
pre.numberSource code > span
{ position: relative; left: -4em; counter-increment: source-line; }
pre.numberSource code > span > a:first-child::before
{ content: counter(source-line);
position: relative; left: -1em; text-align: right; vertical-align: baseline;
border: none; display: inline-block;
-webkit-touch-callout: none; -webkit-user-select: none;
-khtml-user-select: none; -moz-user-select: none;
-ms-user-select: none; user-select: none;
padding: 0 4px; width: 4em;
color: #aaaaaa;
}
pre.numberSource { margin-left: 3em; border-left: 1px solid #aaaaaa; padding-left: 4px; }
div.sourceCode
{ }
@media screen {
pre > code.sourceCode > span > a:first-child::before { text-decoration: underline; }
}
code span.al { color: #ff0000; font-weight: bold; } /* Alert */
code span.an { color: #60a0b0; font-weight: bold; font-style: italic; } /* Annotation */
code span.at { color: #7d9029; } /* Attribute */
code span.bn { color: #40a070; } /* BaseN */
code span.bu { color: #008000; } /* BuiltIn */
code span.cf { color: #007020; font-weight: bold; } /* ControlFlow */
code span.ch { color: #4070a0; } /* Char */
code span.cn { color: #880000; } /* Constant */
code span.co { color: #60a0b0; font-style: italic; } /* Comment */
code span.cv { color: #60a0b0; font-weight: bold; font-style: italic; } /* CommentVar */
code span.do { color: #ba2121; font-style: italic; } /* Documentation */
code span.dt { color: #902000; } /* DataType */
code span.dv { color: #40a070; } /* DecVal */
code span.er { color: #ff0000; font-weight: bold; } /* Error */
code span.ex { } /* Extension */
code span.fl { color: #40a070; } /* Float */
code span.fu { color: #06287e; } /* Function */
code span.im { color: #008000; font-weight: bold; } /* Import */
code span.in { color: #60a0b0; font-weight: bold; font-style: italic; } /* Information */
code span.kw { color: #007020; font-weight: bold; } /* Keyword */
code span.op { color: #666666; } /* Operator */
code span.ot { color: #007020; } /* Other */
code span.pp { color: #bc7a00; } /* Preprocessor */
code span.sc { color: #4070a0; } /* SpecialChar */
code span.ss { color: #bb6688; } /* SpecialString */
code span.st { color: #4070a0; } /* String */
code span.va { color: #19177c; } /* Variable */
code span.vs { color: #4070a0; } /* VerbatimString */
code span.wa { color: #60a0b0; font-weight: bold; font-style: italic; } /* Warning */
</style>
<script src="README_files/libs/clipboard/clipboard.min.js"></script>
<script src="README_files/libs/quarto-html/quarto.js"></script>
<script src="README_files/libs/quarto-html/popper.min.js"></script>
<script src="README_files/libs/quarto-html/tippy.umd.min.js"></script>
<script src="README_files/libs/quarto-html/anchor.min.js"></script>
<link href="README_files/libs/quarto-html/tippy.css" rel="stylesheet">
<link href="README_files/libs/quarto-html/quarto-syntax-highlighting.css" rel="stylesheet" id="quarto-text-highlighting-styles">
<script src="README_files/libs/bootstrap/bootstrap.min.js"></script>
<link href="README_files/libs/bootstrap/bootstrap-icons.css" rel="stylesheet">
<link href="README_files/libs/bootstrap/bootstrap.min.css" rel="stylesheet" id="quarto-bootstrap" data-mode="light">
</head>
<body class="fullcontent">
<div id="quarto-content" class="page-columns page-rows-contents page-layout-article">
<main class="content" id="quarto-document-content">
<section id="the-researchers-guide-to-n3c" class="level1">
<h1>The Researcher’s Guide to N3C</h1>
<p><em><a href="https://national-covid-cohort-collaborative.github.io/guide-to-n3c-v1/">The Researcher’s Guide to N3C: A National Resource for Analyzing Real-World Health Data</a></em> is designed to guide research with the <a href="https://ncats.nih.gov/n3c">National COVID Cohort Collaborative</a> (N3C).</p>
<section id="contributing-content" class="level2">
<h2 class="anchored" data-anchor-id="contributing-content">Contributing Content</h2>
<p>The N3C and its <a href="https://covid.cd2h.org/domain-teams">domain teams</a> are healthiest when assimilating contributions from reseachers of different skills (<em>e.g.</em>, clinicians & informaticians), specialties (<em>e.g.</em>, endocrinology & gerontology), programming languages (<em>e.g.</em>, Python, R, & SQL) and experiences (<em>e.g.</em>, students & PIs).</p>
<p>Accordingly, the <a href="https://github.com/National-COVID-Cohort-Collaborative/guide-to-n3c-v1">guide-to-n3c-v1</a> repository welcomes input from you.</p>
<p>If you see a small mistake or unclear language, we invite you to inform us in a <a href="https://github.com/National-COVID-Cohort-Collaborative/guide-to-n3c-v1/issues">new issue</a> or to edit the source and submitting a <a href="https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests">pull request</a>. When an editor reviews and accepts your change, the website will be updated within minutes.</p>
<p>If you have an idea for something more substantial such as a chapter or section, please start a <a href="https://github.com/National-COVID-Cohort-Collaborative/guide-to-n3c-v1/issues">new issue</a> and the N3C Educational Committee will coordinate with you where it fits best.</p>
</section>
<section id="platform" class="level2">
<h2 class="anchored" data-anchor-id="platform">Platform</h2>
<!-- The section is manually duplicated between index.qmd and README.md. -->
<p>As the chapters are being written, talk to the chapter’s Lead Author to learn if it’s being written in GitHub or Google Docs. Eventually all Google Docs chapters will be translated to Markdown. Once a chapter has been finally converted to Markdown…</p>
<p>To make small changes like spelling corrections, we recommend editing the source directly in GitHub. It handles the details without your knowledge (like starting a fork and prompting your pull request). From the appropriate page of <a href="https://national-covid-cohort-collaborative.github.io/guide-to-n3c-v1/">the book</a>, click on the “Edit this page <i class="fab fa-github" aria-hidden="true"></i>” button and type your change in the <a href="https://docs.github.com/en/repositories/working-with-files/managing-files/editing-files">GitHub editor</a>.</p>
<p>Substantial edits and writing are better accommodated by a text editor on your local machine that can preview the rendered content as you type. We suggest <a href="https://code.visualstudio.com/">Visual Studio Code</a> or <a href="https://www.rstudio.com/products/rstudio/">RStudio</a>.</p>
<p>You don’t have to understand the rest to contribute, but for those interested:</p>
<ul>
<li><p>The majority of this book is written in a collection of <a href="https://guides.github.com/features/mastering-markdown/">Markdown</a> documents and assembled by the <a href="https://quarto.org/">Quarto</a>.</p></li>
<li><p>After your change is pushed to GitHub, a <a href="https://docs.github.com/en/actions/learn-github-actions/understanding-github-actions">GitHub Action</a> spawns a small VM that (a) collects all the Markdown documents, (b) calls <a href="https://quarto.org/">Quarto</a>/<a href="https://pandoc.org/">Pandoc</a> to convert them to html, and (c) moves the rendered html files to the “gh-pages” branch.</p></li>
<li><p>GitHub Pages serves the contents of the <a href="https://github.com/National-COVID-Cohort-Collaborative/guide-to-n3c-v1/tree/gh-pages"><code>gh-pages</code> branch</a> to anyone with a browser.</p></li>
</ul>
</section>
<section id="assets" class="level2">
<h2 class="anchored" data-anchor-id="assets">Assets</h2>
<ul>
<li><p><a href="https://drive.google.com/drive/u/0/folders/1ZFxcvLvJUqMF_RbnQLo8rW7DTMTtahfY">Directory on N3C Google Drive</a></p>
<div class="sourceCode" id="cb1"><pre class="sourceCode sh code-with-copy"><code class="sourceCode bash"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="ex">//N3C</span> allhands National COVID Cohort Collaborative <span class="er">(</span><span class="ex">[email protected]</span><span class="kw">)</span><span class="ex">/WORKSTREAMS</span> <span class="kw">&</span> <span class="ex">SUBGROUPS/Collaborative</span> Analytics/Clinical Scenarios <span class="kw">&</span> <span class="ex">Data</span> Analytics subgroup/Clinical Domain Teams/Education and Training DT/Projects/Guide to N3C <span class="er">(</span><span class="ex">Previously</span> Book of N3C<span class="kw">)</span><span class="ex">/</span></span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div></li>
<li><p><a href="https://docs.google.com/spreadsheets/d/18FWdK1jJXZxhB4t_CKyAHPWkSWIfg5kVcR0vF4_iqlI/edit#gid=0">Status Tracker of Chapters</a></p></li>
<li><p><a href="https://docs.google.com/document/d/1CmAKLcMQcVV_M1OV0zcIxfjiu0xiEWrfKkMMw8zRp6w/edit">Ed Committee Notes</a></p></li>
<li><p><a href="https://docs.google.com/drawings/d/1Z2k0UaukCNsmc8lcxB2lp9ZmOCqrszCWdtntwS4MpQE/edit">Topics Brainstorm</a></p></li>
<li><p><a href="https://docs.google.com/document/d/1ttUKgwVcIZHM87elrlUNV6Qi9thzOwKBg8GegKObEtg/edit">Outline (current)</a></p></li>
<li><p><a href="for-contributors/outline-draft.md">Outline (old)</a></p></li>
</ul>
</section>
<section id="funding" class="level2">
<h2 class="anchored" data-anchor-id="funding">Funding</h2>
<p>The N3C is supported by <a href="https://www.nih.gov/">NIH</a> National Center for Advancing Translational Sciences (<a href="https://ncats.nih.gov/">NCATS</a>).</p>
</section>
<section id="versioning-and-build-status" class="level2">
<h2 class="anchored" data-anchor-id="versioning-and-build-status">Versioning and Build Status</h2>
<p>Zenodo releases: <a href="https://zenodo.org/badge/latestdoi/415068439"><img src="https://zenodo.org/badge/415068439.svg" class="img-fluid" alt="DOI"></a></p>
<!-- badges: start -->
<p>GitHub Actions: <a href="https://github.com/National-COVID-Cohort-Collaborative/guide-to-n3c-v1/actions/workflows/build-book.yaml"><img src="https://github.com/National-COVID-Cohort-Collaborative/guide-to-n3c-v1/actions/workflows/build-book.yaml/badge.svg" class="img-fluid" alt="Build Book"></a> <!-- badges: end --></p>
</section>
</section>
</main>
<!-- /main column -->
<script id="quarto-html-after-body" type="application/javascript">
window.document.addEventListener("DOMContentLoaded", function (event) {
const toggleBodyColorMode = (bsSheetEl) => {
const mode = bsSheetEl.getAttribute("data-mode");
const bodyEl = window.document.querySelector("body");
if (mode === "dark") {
bodyEl.classList.add("quarto-dark");
bodyEl.classList.remove("quarto-light");
} else {
bodyEl.classList.add("quarto-light");
bodyEl.classList.remove("quarto-dark");
}
}
const toggleBodyColorPrimary = () => {
const bsSheetEl = window.document.querySelector("link#quarto-bootstrap");
if (bsSheetEl) {
toggleBodyColorMode(bsSheetEl);
}
}
toggleBodyColorPrimary();
const icon = "";
const anchorJS = new window.AnchorJS();
anchorJS.options = {
placement: 'right',
icon: icon
};
anchorJS.add('.anchored');
const clipboard = new window.ClipboardJS('.code-copy-button', {
target: function(trigger) {
return trigger.previousElementSibling;
}
});
clipboard.on('success', function(e) {
// button target
const button = e.trigger;
// don't keep focus
button.blur();
// flash "checked"
button.classList.add('code-copy-button-checked');
var currentTitle = button.getAttribute("title");
button.setAttribute("title", "Copied!");
let tooltip;
if (window.bootstrap) {
button.setAttribute("data-bs-toggle", "tooltip");
button.setAttribute("data-bs-placement", "left");
button.setAttribute("data-bs-title", "Copied!");
tooltip = new bootstrap.Tooltip(button,
{ trigger: "manual",
customClass: "code-copy-button-tooltip",
offset: [0, -8]});
tooltip.show();
}
setTimeout(function() {
if (tooltip) {
tooltip.hide();
button.removeAttribute("data-bs-title");
button.removeAttribute("data-bs-toggle");
button.removeAttribute("data-bs-placement");
}
button.setAttribute("title", currentTitle);
button.classList.remove('code-copy-button-checked');
}, 1000);
// clear code selection
e.clearSelection();
});
function tippyHover(el, contentFn) {
const config = {
allowHTML: true,
content: contentFn,
maxWidth: 500,
delay: 100,
arrow: false,
appendTo: function(el) {
return el.parentElement;
},
interactive: true,
interactiveBorder: 10,
theme: 'quarto',
placement: 'bottom-start'
};
window.tippy(el, config);
}
const noterefs = window.document.querySelectorAll('a[role="doc-noteref"]');
for (var i=0; i<noterefs.length; i++) {
const ref = noterefs[i];
tippyHover(ref, function() {
// use id or data attribute instead here
let href = ref.getAttribute('data-footnote-href') || ref.getAttribute('href');
try { href = new URL(href).hash; } catch {}
const id = href.replace(/^#\/?/, "");
const note = window.document.getElementById(id);
return note.innerHTML;
});
}
const findCites = (el) => {
const parentEl = el.parentElement;
if (parentEl) {
const cites = parentEl.dataset.cites;
if (cites) {
return {
el,
cites: cites.split(' ')
};
} else {
return findCites(el.parentElement)
}
} else {
return undefined;
}
};
var bibliorefs = window.document.querySelectorAll('a[role="doc-biblioref"]');
for (var i=0; i<bibliorefs.length; i++) {
const ref = bibliorefs[i];
const citeInfo = findCites(ref);
if (citeInfo) {
tippyHover(citeInfo.el, function() {
var popup = window.document.createElement('div');
citeInfo.cites.forEach(function(cite) {
var citeDiv = window.document.createElement('div');
citeDiv.classList.add('hanging-indent');
citeDiv.classList.add('csl-entry');
var biblioDiv = window.document.getElementById('ref-' + cite);
if (biblioDiv) {
citeDiv.innerHTML = biblioDiv.innerHTML;
}
popup.appendChild(citeDiv);
});
return popup.innerHTML;
});
}
}
});
</script>
</div> <!-- /content -->
</body></html>