mirror of
https://github.com/agdamsbo/REDCapCAST.git
synced 2024-11-21 21:10:22 +01:00
163 lines
17 KiB
HTML
163 lines
17 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>DEPRICATED Create zips file with necessary content based on data set — create_instrument_meta • 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="DEPRICATED Create zips file with necessary content based on data set — create_instrument_meta"><meta name="description" content="Metadata can be added by editing the data dictionary of a project in the
|
||
initial design phase. If you want to later add new instruments, this
|
||
function can be used to create (an) instrument(s) to add to a project in
|
||
production."><meta property="og:description" content="Metadata can be added by editing the data dictionary of a project in the
|
||
initial design phase. If you want to later add new instruments, this
|
||
function can be used to create (an) instrument(s) to add to a project in
|
||
production."><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>DEPRICATED Create zips file with necessary content based on data set</h1>
|
||
<small class="dont-index">Source: <a href="https://github.com/agdamsbo/REDCapCAST/blob/main/R/export_redcap_instrument.R" class="external-link"><code>R/export_redcap_instrument.R</code></a></small>
|
||
<div class="d-none name"><code>create_instrument_meta.Rd</code></div>
|
||
</div>
|
||
|
||
<div class="ref-description section level2">
|
||
<p>Metadata can be added by editing the data dictionary of a project in the
|
||
initial design phase. If you want to later add new instruments, this
|
||
function can be used to create (an) instrument(s) to add to a project in
|
||
production.</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">create_instrument_meta</span><span class="op">(</span><span class="va">data</span>, dir <span class="op">=</span> <span class="fu">here</span><span class="fu">::</span><span class="fu"><a href="https://here.r-lib.org//reference/here.html" class="external-link">here</a></span><span class="op">(</span><span class="st">""</span><span class="op">)</span>, record.id <span class="op">=</span> <span class="cn">TRUE</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>metadata for the relevant instrument.
|
||
Could be from `ds2dd_detailed()`</p></dd>
|
||
|
||
|
||
<dt id="arg-dir">dir<a class="anchor" aria-label="anchor" href="#arg-dir"></a></dt>
|
||
<dd><p>destination dir for the instrument zip. Default is the current WD.</p></dd>
|
||
|
||
|
||
<dt id="arg-record-id">record.id<a class="anchor" aria-label="anchor" href="#arg-record-id"></a></dt>
|
||
<dd><p>flag to omit the first row of the data dictionary assuming
|
||
this is the record_id field which should not be included in the instrument.
|
||
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</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="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"><a href="ds2dd_detailed.html">ds2dd_detailed</a></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>,</span></span>
|
||
<span class="r-in"><span> size <span class="op">=</span> <span class="fl">6</span>,</span></span>
|
||
<span class="r-in"><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></span>
|
||
<span class="r-in"><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-msg co"><span class="r-pr">#></span> A default id column has been added</span>
|
||
<span class="r-in"><span><span class="co"># data |> create_instrument_meta()</span></span></span>
|
||
<span class="r-in"><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"><a href="ds2dd_detailed.html">ds2dd_detailed</a></span><span class="op">(</span>add.auto.id <span class="op">=</span> <span class="cn">FALSE</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="va">iris</span> <span class="op">|></span></span></span>
|
||
<span class="r-in"><span> <span class="fu"><a href="https://rdrr.io/r/stats/setNames.html" class="external-link">setNames</a></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(ncol(iris)),</span></span></span>
|
||
<span class="r-in"><span><span class="st">replace=TRUE,prob = rep(x=.5,2))}__{names(iris)}"</span><span class="op">)</span><span class="op">)</span> <span class="op">|></span></span></span>
|
||
<span class="r-in"><span> <span class="fu"><a href="ds2dd_detailed.html">ds2dd_detailed</a></span><span class="op">(</span>form.sep <span class="op">=</span> <span class="st">"__"</span><span class="op">)</span></span></span>
|
||
<span class="r-out co"><span class="r-pr">#></span> $data</span>
|
||
<span class="r-out co"><span class="r-pr">#></span> <span style="color: #949494;"># A tibble: 150 × 5</span></span>
|
||
<span class="r-out co"><span class="r-pr">#></span> Sepal.Length Sepal.Width Petal.Length Petal.Width Species</span>
|
||
<span class="r-out co"><span class="r-pr">#></span> <span style="color: #949494; font-style: italic;"><dbl></span> <span style="color: #949494; font-style: italic;"><dbl></span> <span style="color: #949494; font-style: italic;"><dbl></span> <span style="color: #949494; font-style: italic;"><dbl></span> <span style="color: #949494; font-style: italic;"><fct></span> </span>
|
||
<span class="r-out co"><span class="r-pr">#></span> <span style="color: #BCBCBC;"> 1</span> 5.1 3.5 1.4 0.2 setosa </span>
|
||
<span class="r-out co"><span class="r-pr">#></span> <span style="color: #BCBCBC;"> 2</span> 4.9 3 1.4 0.2 setosa </span>
|
||
<span class="r-out co"><span class="r-pr">#></span> <span style="color: #BCBCBC;"> 3</span> 4.7 3.2 1.3 0.2 setosa </span>
|
||
<span class="r-out co"><span class="r-pr">#></span> <span style="color: #BCBCBC;"> 4</span> 4.6 3.1 1.5 0.2 setosa </span>
|
||
<span class="r-out co"><span class="r-pr">#></span> <span style="color: #BCBCBC;"> 5</span> 5 3.6 1.4 0.2 setosa </span>
|
||
<span class="r-out co"><span class="r-pr">#></span> <span style="color: #BCBCBC;"> 6</span> 5.4 3.9 1.7 0.4 setosa </span>
|
||
<span class="r-out co"><span class="r-pr">#></span> <span style="color: #BCBCBC;"> 7</span> 4.6 3.4 1.4 0.3 setosa </span>
|
||
<span class="r-out co"><span class="r-pr">#></span> <span style="color: #BCBCBC;"> 8</span> 5 3.4 1.5 0.2 setosa </span>
|
||
<span class="r-out co"><span class="r-pr">#></span> <span style="color: #BCBCBC;"> 9</span> 4.4 2.9 1.4 0.2 setosa </span>
|
||
<span class="r-out co"><span class="r-pr">#></span> <span style="color: #BCBCBC;">10</span> 4.9 3.1 1.5 0.1 setosa </span>
|
||
<span class="r-out co"><span class="r-pr">#></span> <span style="color: #949494;"># ℹ 140 more rows</span></span>
|
||
<span class="r-out co"><span class="r-pr">#></span> </span>
|
||
<span class="r-out co"><span class="r-pr">#></span> $meta</span>
|
||
<span class="r-out co"><span class="r-pr">#></span> <span style="color: #949494;"># A tibble: 5 × 18</span></span>
|
||
<span class="r-out co"><span class="r-pr">#></span> field_name form_name section_header field_type field_label </span>
|
||
<span class="r-out co"><span class="r-pr">#></span> <span style="color: #949494; font-style: italic;"><chr></span> <span style="color: #949494; font-style: italic;"><chr></span> <span style="color: #949494; font-style: italic;"><lgl></span> <span style="color: #949494; font-style: italic;"><chr></span> <span style="color: #949494; font-style: italic;"><chr></span> </span>
|
||
<span class="r-out co"><span class="r-pr">#></span> <span style="color: #BCBCBC;">1</span> Sepal.Length b <span style="color: #BB0000;">NA</span> text Sepal.Length</span>
|
||
<span class="r-out co"><span class="r-pr">#></span> <span style="color: #BCBCBC;">2</span> Sepal.Width b <span style="color: #BB0000;">NA</span> text Sepal.Width </span>
|
||
<span class="r-out co"><span class="r-pr">#></span> <span style="color: #BCBCBC;">3</span> Petal.Length b <span style="color: #BB0000;">NA</span> text Petal.Length</span>
|
||
<span class="r-out co"><span class="r-pr">#></span> <span style="color: #BCBCBC;">4</span> Petal.Width b <span style="color: #BB0000;">NA</span> text Petal.Width </span>
|
||
<span class="r-out co"><span class="r-pr">#></span> <span style="color: #BCBCBC;">5</span> Species b <span style="color: #BB0000;">NA</span> radio Species </span>
|
||
<span class="r-out co"><span class="r-pr">#></span> <span style="color: #949494;"># ℹ 13 more variables: select_choices_or_calculations <chr>, field_note <lgl>,</span></span>
|
||
<span class="r-out co"><span class="r-pr">#></span> <span style="color: #949494;"># text_validation_type_or_show_slider_number <chr>,</span></span>
|
||
<span class="r-out co"><span class="r-pr">#></span> <span style="color: #949494;"># text_validation_min <lgl>, text_validation_max <lgl>, identifier <lgl>,</span></span>
|
||
<span class="r-out co"><span class="r-pr">#></span> <span style="color: #949494;"># branching_logic <lgl>, required_field <lgl>, custom_alignment <lgl>,</span></span>
|
||
<span class="r-out co"><span class="r-pr">#></span> <span style="color: #949494;"># question_number <lgl>, matrix_group_name <lgl>, matrix_ranking <lgl>,</span></span>
|
||
<span class="r-out co"><span class="r-pr">#></span> <span style="color: #949494;"># field_annotation <lgl></span></span>
|
||
<span class="r-out co"><span class="r-pr">#></span> </span>
|
||
<span class="r-out co"><span class="r-pr">#></span> attr(,"class")</span>
|
||
<span class="r-out co"><span class="r-pr">#></span> [1] "REDCapCAST" "list" </span>
|
||
<span class="r-in"><span><span class="co"># data |></span></span></span>
|
||
<span class="r-in"><span><span class="co"># purrr::pluck("meta") |></span></span></span>
|
||
<span class="r-in"><span><span class="co"># create_instrument_meta(record.id = FALSE)</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>
|
||
|