mirror of
https://github.com/agdamsbo/REDCapCAST.git
synced 2024-11-21 21:10:22 +01:00
184 lines
12 KiB
HTML
184 lines
12 KiB
HTML
<!DOCTYPE html>
|
|
<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><title>Doc table to data dictionary - EARLY, DOCS MISSING — doc2dd • REDCapCAST</title><!-- favicons --><link rel="icon" type="image/png" sizes="16x16" href="../favicon-16x16.png"><link rel="icon" type="image/png" sizes="32x32" href="../favicon-32x32.png"><link rel="apple-touch-icon" type="image/png" sizes="180x180" href="../apple-touch-icon.png"><link rel="apple-touch-icon" type="image/png" sizes="120x120" href="../apple-touch-icon-120x120.png"><link rel="apple-touch-icon" type="image/png" sizes="76x76" href="../apple-touch-icon-76x76.png"><link rel="apple-touch-icon" type="image/png" sizes="60x60" href="../apple-touch-icon-60x60.png"><script src="../deps/jquery-3.6.0/jquery-3.6.0.min.js"></script><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><link href="../deps/bootstrap-5.3.1/bootstrap.min.css" rel="stylesheet"><script src="../deps/bootstrap-5.3.1/bootstrap.bundle.min.js"></script><link href="../deps/font-awesome-6.5.2/css/all.min.css" rel="stylesheet"><link href="../deps/font-awesome-6.5.2/css/v4-shims.min.css" rel="stylesheet"><script src="../deps/headroom-0.11.0/headroom.min.js"></script><script src="../deps/headroom-0.11.0/jQuery.headroom.min.js"></script><script src="../deps/bootstrap-toc-1.0.1/bootstrap-toc.min.js"></script><script src="../deps/clipboard.js-2.0.11/clipboard.min.js"></script><script src="../deps/search-1.0.0/autocomplete.jquery.min.js"></script><script src="../deps/search-1.0.0/fuse.min.js"></script><script src="../deps/search-1.0.0/mark.min.js"></script><!-- pkgdown --><script src="../pkgdown.js"></script><meta property="og:title" content="Doc table to data dictionary - EARLY, DOCS MISSING — doc2dd"><meta name="description" content="Works well with `project.aid::docx2list()`.
|
|
Allows defining a database in a text document (see provided template) for
|
|
an easier to use data base creation. This approach allows easier
|
|
collaboration when defining the database. The generic case is a data frame
|
|
with variable names as values in a column. This is a format like the REDCap
|
|
data dictionary, but gives a few options for formatting."><meta property="og:description" content="Works well with `project.aid::docx2list()`.
|
|
Allows defining a database in a text document (see provided template) for
|
|
an easier to use data base creation. This approach allows easier
|
|
collaboration when defining the database. The generic case is a data frame
|
|
with variable names as values in a column. This is a format like the REDCap
|
|
data dictionary, but gives a few options for formatting."><meta property="og:image" content="https://agdamsbo.github.io/REDCapCAST/logo.png"></head><body>
|
|
<a href="#main" class="visually-hidden-focusable">Skip to contents</a>
|
|
|
|
|
|
<nav class="navbar navbar-expand-lg fixed-top bg-light" data-bs-theme="light" aria-label="Site navigation"><div class="container">
|
|
|
|
<a class="navbar-brand me-2" href="../index.html">REDCapCAST</a>
|
|
|
|
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">24.11.2</small>
|
|
|
|
|
|
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
|
|
<span class="navbar-toggler-icon"></span>
|
|
</button>
|
|
|
|
<div id="navbar" class="collapse navbar-collapse ms-3">
|
|
<ul class="navbar-nav me-auto"><li class="nav-item"><a class="nav-link" href="../articles/REDCapCAST.html">Get started</a></li>
|
|
<li class="active nav-item"><a class="nav-link" href="../reference/index.html">Reference</a></li>
|
|
<li class="nav-item dropdown">
|
|
<button class="nav-link dropdown-toggle" type="button" id="dropdown-articles" data-bs-toggle="dropdown" aria-expanded="false" aria-haspopup="true">Articles</button>
|
|
<ul class="dropdown-menu" aria-labelledby="dropdown-articles"><li><a class="dropdown-item" href="../articles/Database-creation.html">Database-creation</a></li>
|
|
<li><a class="dropdown-item" href="../articles/Shiny-app.html">Shiny-app</a></li>
|
|
</ul></li>
|
|
<li class="nav-item"><a class="nav-link" href="../news/index.html">Changelog</a></li>
|
|
</ul><ul class="navbar-nav"><li class="nav-item"><form class="form-inline" role="search">
|
|
<input class="form-control" type="search" name="search-input" id="search-input" autocomplete="off" aria-label="Search site" placeholder="Search for" data-search-index="../search.json"></form></li>
|
|
<li class="nav-item"><a class="external-link nav-link" href="https://github.com/agdamsbo/REDCapCAST/" aria-label="GitHub"><span class="fa fab fa-github fa-lg"></span></a></li>
|
|
</ul></div>
|
|
|
|
|
|
</div>
|
|
</nav><div class="container template-reference-topic">
|
|
<div class="row">
|
|
<main id="main" class="col-md-9"><div class="page-header">
|
|
<img src="../logo.png" class="logo" alt=""><h1>Doc table to data dictionary - EARLY, DOCS MISSING</h1>
|
|
<small class="dont-index">Source: <a href="https://github.com/agdamsbo/REDCapCAST/blob/main/R/doc2dd.R" class="external-link"><code>R/doc2dd.R</code></a></small>
|
|
<div class="d-none name"><code>doc2dd.Rd</code></div>
|
|
</div>
|
|
|
|
<div class="ref-description section level2">
|
|
<p>Works well with `project.aid::docx2list()`.
|
|
Allows defining a database in a text document (see provided template) for
|
|
an easier to use data base creation. This approach allows easier
|
|
collaboration when defining the database. The generic case is a data frame
|
|
with variable names as values in a column. This is a format like the REDCap
|
|
data dictionary, but gives a few options for formatting.</p>
|
|
</div>
|
|
|
|
<div class="section level2">
|
|
<h2 id="ref-usage">Usage<a class="anchor" aria-label="anchor" href="#ref-usage"></a></h2>
|
|
<div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">doc2dd</span><span class="op">(</span></span>
|
|
<span> <span class="va">data</span>,</span>
|
|
<span> <span class="va">instrument.name</span>,</span>
|
|
<span> col.variables <span class="op">=</span> <span class="fl">1</span>,</span>
|
|
<span> list.datetime.format <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/list.html" class="external-link">list</a></span><span class="op">(</span>date_dmy <span class="op">=</span> <span class="st">"_dat[eo]$"</span>, time_hh_mm_ss <span class="op">=</span> <span class="st">"_ti[md]e?$"</span><span class="op">)</span>,</span>
|
|
<span> col.description <span class="op">=</span> <span class="cn">NULL</span>,</span>
|
|
<span> col.condition <span class="op">=</span> <span class="cn">NULL</span>,</span>
|
|
<span> col.subheader <span class="op">=</span> <span class="cn">NULL</span>,</span>
|
|
<span> subheader.tag <span class="op">=</span> <span class="st">"h2"</span>,</span>
|
|
<span> condition.minor.sep <span class="op">=</span> <span class="st">","</span>,</span>
|
|
<span> condition.major.sep <span class="op">=</span> <span class="st">";"</span>,</span>
|
|
<span> col.calculation <span class="op">=</span> <span class="cn">NULL</span>,</span>
|
|
<span> col.choices <span class="op">=</span> <span class="cn">NULL</span>,</span>
|
|
<span> choices.char.sep <span class="op">=</span> <span class="st">"/"</span>,</span>
|
|
<span> missing.default <span class="op">=</span> <span class="cn">NA</span></span>
|
|
<span><span class="op">)</span></span></code></pre></div>
|
|
</div>
|
|
|
|
<div class="section level2">
|
|
<h2 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h2>
|
|
|
|
|
|
<dl><dt id="arg-data">data<a class="anchor" aria-label="anchor" href="#arg-data"></a></dt>
|
|
<dd><p>tibble or data.frame with all variable names in one column</p></dd>
|
|
|
|
|
|
<dt id="arg-instrument-name">instrument.name<a class="anchor" aria-label="anchor" href="#arg-instrument-name"></a></dt>
|
|
<dd><p>character vector length one. Instrument name.</p></dd>
|
|
|
|
|
|
<dt id="arg-col-variables">col.variables<a class="anchor" aria-label="anchor" href="#arg-col-variables"></a></dt>
|
|
<dd><p>variable names column (default = 1), allows dplyr
|
|
subsetting</p></dd>
|
|
|
|
|
|
<dt id="arg-list-datetime-format">list.datetime.format<a class="anchor" aria-label="anchor" href="#arg-list-datetime-format"></a></dt>
|
|
<dd><p>formatting for date/time detection.
|
|
See `case_match_regex_list()`</p></dd>
|
|
|
|
|
|
<dt id="arg-col-description">col.description<a class="anchor" aria-label="anchor" href="#arg-col-description"></a></dt>
|
|
<dd><p>descriptions column, allows dplyr
|
|
subsetting. If empty, variable names will be used.</p></dd>
|
|
|
|
|
|
<dt id="arg-col-condition">col.condition<a class="anchor" aria-label="anchor" href="#arg-col-condition"></a></dt>
|
|
<dd><p>conditions for branching column, allows dplyr
|
|
subsetting. See `char2cond()`.</p></dd>
|
|
|
|
|
|
<dt id="arg-col-subheader">col.subheader<a class="anchor" aria-label="anchor" href="#arg-col-subheader"></a></dt>
|
|
<dd><p>sub-header column, allows dplyr subsetting.
|
|
See `format_subheader()`.</p></dd>
|
|
|
|
|
|
<dt id="arg-subheader-tag">subheader.tag<a class="anchor" aria-label="anchor" href="#arg-subheader-tag"></a></dt>
|
|
<dd><p>formatting tag. Default is "h2"</p></dd>
|
|
|
|
|
|
<dt id="arg-condition-minor-sep">condition.minor.sep<a class="anchor" aria-label="anchor" href="#arg-condition-minor-sep"></a></dt>
|
|
<dd><p>condition split minor. See `char2cond()`.
|
|
Default is ",".</p></dd>
|
|
|
|
|
|
<dt id="arg-condition-major-sep">condition.major.sep<a class="anchor" aria-label="anchor" href="#arg-condition-major-sep"></a></dt>
|
|
<dd><p>condition split major. See `char2cond()`.
|
|
Default is ";".</p></dd>
|
|
|
|
|
|
<dt id="arg-col-calculation">col.calculation<a class="anchor" aria-label="anchor" href="#arg-col-calculation"></a></dt>
|
|
<dd><p>calculations column. Has to be written exact.
|
|
Character vector.</p></dd>
|
|
|
|
|
|
<dt id="arg-col-choices">col.choices<a class="anchor" aria-label="anchor" href="#arg-col-choices"></a></dt>
|
|
<dd><p>choices column. See `char2choice()`.</p></dd>
|
|
|
|
|
|
<dt id="arg-choices-char-sep">choices.char.sep<a class="anchor" aria-label="anchor" href="#arg-choices-char-sep"></a></dt>
|
|
<dd><p>choices split. See `char2choice()`. Default is "/".</p></dd>
|
|
|
|
|
|
<dt id="arg-missing-default">missing.default<a class="anchor" aria-label="anchor" href="#arg-missing-default"></a></dt>
|
|
<dd><p>value for missing fields. Default is NA.</p></dd>
|
|
|
|
</dl></div>
|
|
<div class="section level2">
|
|
<h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
|
|
<p>tibble or data.frame (same as data)</p>
|
|
</div>
|
|
|
|
<div class="section level2">
|
|
<h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-examples"></a></h2>
|
|
<div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="co"># data <- dd_inst</span></span></span>
|
|
<span class="r-in"><span><span class="co"># data |> doc2dd(instrument.name = "evt",</span></span></span>
|
|
<span class="r-in"><span><span class="co"># col.description = 3,</span></span></span>
|
|
<span class="r-in"><span><span class="co"># col.condition = 4,</span></span></span>
|
|
<span class="r-in"><span><span class="co"># col.subheader = 2,</span></span></span>
|
|
<span class="r-in"><span><span class="co"># col.calculation = 5,</span></span></span>
|
|
<span class="r-in"><span><span class="co"># col.choices = 6)</span></span></span>
|
|
</code></pre></div>
|
|
</div>
|
|
</main><aside class="col-md-3"><nav id="toc" aria-label="Table of contents"><h2>On this page</h2>
|
|
</nav></aside></div>
|
|
|
|
|
|
<footer><div class="pkgdown-footer-left">
|
|
<p>Developed by Andreas Gammelgaard Damsbo, Paul Egeler.</p>
|
|
</div>
|
|
|
|
<div class="pkgdown-footer-right">
|
|
<p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.1.1.</p>
|
|
</div>
|
|
|
|
</footer></div>
|
|
|
|
|
|
|
|
|
|
|
|
</body></html>
|
|
|