mirror of
https://github.com/agdamsbo/REDCapCAST.git
synced 2024-11-21 21:10:22 +01:00
185 lines
15 KiB
HTML
185 lines
15 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>Extract data from stata file for data dictionary — ds2dd_detailed • 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="Extract data from stata file for data dictionary — ds2dd_detailed"><meta name="description" content="Extract data from stata file for data dictionary"><meta property="og:description" content="Extract data from stata file for data dictionary"><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>Extract data from stata file for data dictionary</h1>
|
|
<small class="dont-index">Source: <a href="https://github.com/agdamsbo/REDCapCAST/blob/main/R/ds2dd_detailed.R" class="external-link"><code>R/ds2dd_detailed.R</code></a></small>
|
|
<div class="d-none name"><code>ds2dd_detailed.Rd</code></div>
|
|
</div>
|
|
|
|
<div class="ref-description section level2">
|
|
<p>Extract data from stata file for data dictionary</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">ds2dd_detailed</span><span class="op">(</span></span>
|
|
<span> <span class="va">data</span>,</span>
|
|
<span> add.auto.id <span class="op">=</span> <span class="cn">FALSE</span>,</span>
|
|
<span> date.format <span class="op">=</span> <span class="st">"dmy"</span>,</span>
|
|
<span> form.name <span class="op">=</span> <span class="cn">NULL</span>,</span>
|
|
<span> form.sep <span class="op">=</span> <span class="cn">NULL</span>,</span>
|
|
<span> form.prefix <span class="op">=</span> <span class="cn">TRUE</span>,</span>
|
|
<span> field.type <span class="op">=</span> <span class="cn">NULL</span>,</span>
|
|
<span> field.label <span class="op">=</span> <span class="cn">NULL</span>,</span>
|
|
<span> field.label.attr <span class="op">=</span> <span class="st">"label"</span>,</span>
|
|
<span> field.validation <span class="op">=</span> <span class="cn">NULL</span>,</span>
|
|
<span> metadata <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/names.html" class="external-link">names</a></span><span class="op">(</span><span class="fu">REDCapCAST</span><span class="fu">::</span><span class="va"><a href="redcapcast_meta.html">redcapcast_meta</a></span><span class="op">)</span>,</span>
|
|
<span> convert.logicals <span class="op">=</span> <span class="cn">TRUE</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>data frame</p></dd>
|
|
|
|
|
|
<dt id="arg-add-auto-id">add.auto.id<a class="anchor" aria-label="anchor" href="#arg-add-auto-id"></a></dt>
|
|
<dd><p>flag to add id column</p></dd>
|
|
|
|
|
|
<dt id="arg-date-format">date.format<a class="anchor" aria-label="anchor" href="#arg-date-format"></a></dt>
|
|
<dd><p>date format, character string. ymd/dmy/mdy. dafault is
|
|
dmy.</p></dd>
|
|
|
|
|
|
<dt id="arg-form-name">form.name<a class="anchor" aria-label="anchor" href="#arg-form-name"></a></dt>
|
|
<dd><p>manually specify form name(s). Vector of length 1 or
|
|
ncol(data). Default is NULL and "data" is used.</p></dd>
|
|
|
|
|
|
<dt id="arg-form-sep">form.sep<a class="anchor" aria-label="anchor" href="#arg-form-sep"></a></dt>
|
|
<dd><p>If supplied dataset has form names as suffix or prefix to the
|
|
column/variable names, the seperator can be specified. If supplied, the
|
|
form.name is ignored. Default is NULL.</p></dd>
|
|
|
|
|
|
<dt id="arg-form-prefix">form.prefix<a class="anchor" aria-label="anchor" href="#arg-form-prefix"></a></dt>
|
|
<dd><p>Flag to set if form is prefix (TRUE) or suffix (FALSE) to
|
|
the column names. Assumes all columns have pre- or suffix if specified.</p></dd>
|
|
|
|
|
|
<dt id="arg-field-type">field.type<a class="anchor" aria-label="anchor" href="#arg-field-type"></a></dt>
|
|
<dd><p>manually specify field type(s). Vector of length 1 or
|
|
ncol(data). Default is NULL and "text" is used for everything but factors,
|
|
which wil get "radio".</p></dd>
|
|
|
|
|
|
<dt id="arg-field-label">field.label<a class="anchor" aria-label="anchor" href="#arg-field-label"></a></dt>
|
|
<dd><p>manually specify field label(s). Vector of length 1 or
|
|
ncol(data). Default is NULL and colnames(data) is used or attribute
|
|
`field.label.attr` for haven_labelled data set (imported .dta file with
|
|
`haven::read_dta()`).</p></dd>
|
|
|
|
|
|
<dt id="arg-field-label-attr">field.label.attr<a class="anchor" aria-label="anchor" href="#arg-field-label-attr"></a></dt>
|
|
<dd><p>attribute name for named labels for haven_labelled
|
|
data set (imported .dta file with `haven::read_dta()`. Default is "label"</p></dd>
|
|
|
|
|
|
<dt id="arg-field-validation">field.validation<a class="anchor" aria-label="anchor" href="#arg-field-validation"></a></dt>
|
|
<dd><p>manually specify field validation(s). Vector of
|
|
length 1 or ncol(data). Default is NULL and `levels()` are used for factors
|
|
or attribute `factor.labels.attr` for haven_labelled data set (imported .dta
|
|
file with `haven::read_dta()`).</p></dd>
|
|
|
|
|
|
<dt id="arg-metadata">metadata<a class="anchor" aria-label="anchor" href="#arg-metadata"></a></dt>
|
|
<dd><p>redcap metadata headings. Default is
|
|
REDCapCAST:::metadata_names.</p></dd>
|
|
|
|
|
|
<dt id="arg-convert-logicals">convert.logicals<a class="anchor" aria-label="anchor" href="#arg-convert-logicals"></a></dt>
|
|
<dd><p>convert logicals to factor. Default is TRUE.</p></dd>
|
|
|
|
</dl></div>
|
|
<div class="section level2">
|
|
<h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
|
|
<p>list of length 2</p>
|
|
</div>
|
|
<div class="section level2">
|
|
<h2 id="details">Details<a class="anchor" aria-label="anchor" href="#details"></a></h2>
|
|
<p>This function is a natural development of the ds2dd() function. It assumes
|
|
that the first column is the ID-column. No checks.
|
|
Please, do always inspect the data dictionary before upload.</p>
|
|
<p>Ensure, that the data set is formatted with as much information as possible.</p>
|
|
<p>`field.type` can be supplied</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="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="op">{</span> <span class="co"># \dontrun{</span></span></span>
|
|
<span class="r-in"><span><span class="va">data</span> <span class="op"><-</span> <span class="fu">REDCapCAST</span><span class="fu">::</span><span class="va"><a href="redcapcast_data.html">redcapcast_data</a></span></span></span>
|
|
<span class="r-in"><span><span class="va">data</span> <span class="op">|></span> <span class="fu">ds2dd_detailed</span><span class="op">(</span><span class="op">)</span></span></span>
|
|
<span class="r-in"><span><span class="va">iris</span> <span class="op">|></span> <span class="fu">ds2dd_detailed</span><span class="op">(</span>add.auto.id <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span></span>
|
|
<span class="r-in"><span><span class="va">iris</span> <span class="op">|></span></span></span>
|
|
<span class="r-in"><span> <span class="fu">ds2dd_detailed</span><span class="op">(</span></span></span>
|
|
<span class="r-in"><span> add.auto.id <span class="op">=</span> <span class="cn">TRUE</span>,</span></span>
|
|
<span class="r-in"><span> form.name <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/sample.html" class="external-link">sample</a></span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"b"</span>, <span class="st">"c"</span><span class="op">)</span>, size <span class="op">=</span> <span class="fl">6</span>, replace <span class="op">=</span> <span class="cn">TRUE</span>, prob <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/rep.html" class="external-link">rep</a></span><span class="op">(</span><span class="fl">.5</span>, <span class="fl">2</span><span class="op">)</span><span class="op">)</span></span></span>
|
|
<span class="r-in"><span> <span class="op">)</span> <span class="op">|></span></span></span>
|
|
<span class="r-in"><span> <span class="fu">purrr</span><span class="fu">::</span><span class="fu"><a href="https://purrr.tidyverse.org/reference/pluck.html" class="external-link">pluck</a></span><span class="op">(</span><span class="st">"meta"</span><span class="op">)</span></span></span>
|
|
<span class="r-in"><span><span class="va">mtcars</span> <span class="op">|></span> <span class="fu">ds2dd_detailed</span><span class="op">(</span>add.auto.id <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span></span>
|
|
<span class="r-in"><span><span class="va">data</span> <span class="op"><-</span> <span class="va">iris</span> <span class="op">|></span></span></span>
|
|
<span class="r-in"><span> <span class="fu">ds2dd_detailed</span><span class="op">(</span>add.auto.id <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span> <span class="op">|></span></span></span>
|
|
<span class="r-in"><span> <span class="fu">purrr</span><span class="fu">::</span><span class="fu"><a href="https://purrr.tidyverse.org/reference/pluck.html" class="external-link">pluck</a></span><span class="op">(</span><span class="st">"data"</span><span class="op">)</span></span></span>
|
|
<span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/base/names.html" class="external-link">names</a></span><span class="op">(</span><span class="va">data</span><span class="op">)</span> <span class="op"><-</span> <span class="fu">glue</span><span class="fu">::</span><span class="fu"><a href="https://glue.tidyverse.org/reference/glue.html" class="external-link">glue</a></span><span class="op">(</span><span class="st">"{sample(x = c('a','b'),size = length(names(data)),</span></span></span>
|
|
<span class="r-in"><span><span class="st">replace=TRUE,prob = rep(x=.5,2))}__{names(data)}"</span><span class="op">)</span></span></span>
|
|
<span class="r-in"><span><span class="va">data</span> <span class="op">|></span> <span class="fu">ds2dd_detailed</span><span class="op">(</span>form.sep <span class="op">=</span> <span class="st">"__"</span><span class="op">)</span></span></span>
|
|
<span class="r-in"><span><span class="op">}</span> <span class="co"># }</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>
|
|
|