mirror of
https://github.com/agdamsbo/REDCapCAST.git
synced 2024-11-24 14:01:55 +01:00
231 lines
12 KiB
HTML
231 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>Function reference • 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><!-- Font Awesome icons --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous"><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity="sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin="anonymous"><!-- bootstrap-toc --><script src="https://cdn.jsdelivr.net/gh/afeld/bootstrap-toc@v1.0.1/dist/bootstrap-toc.min.js" integrity="sha256-4veVQbu7//Lk5TSmc7YV48MxtMy98e26cf5MrgZYnwo=" crossorigin="anonymous"></script><!-- headroom.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script><!-- clipboard.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script><!-- search --><script src="https://cdnjs.cloudflare.com/ajax/libs/fuse.js/6.4.6/fuse.js" integrity="sha512-zv6Ywkjyktsohkbp9bb45V6tEMoWhzFzXis+LrMehmJZZSys19Yxf1dopHx7WzIKxr5tK2dVcYmaCk2uqdjF4A==" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/autocomplete.js/0.38.0/autocomplete.jquery.min.js" integrity="sha512-GU9ayf+66Xx2TmpxqJpliWbT5PiGYxpaG8rfnBEk1LL8l1KGkRShhngwdXK1UgqhAzWpZHSiYPc09/NwDQIGyg==" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mark.js/8.11.1/mark.min.js" integrity="sha512-5CYOlHXGh6QpOFA/TeTylKLWfB3ftPsde7AnmhuitiTX4K5SqCLBeKro6sPS8ilsz1Q4NRx3v8Ko2IBiszzdww==" crossorigin="anonymous"></script><!-- pkgdown --><script src="../pkgdown.js"></script><meta property="og:title" content="Function reference"><meta property="og:image" content="https://agdamsbo.github.io/REDCapCAST/logo.png"><!-- mathjax --><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script><!--[if lt IE 9]>
|
|
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
|
|
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
|
|
<![endif]--></head><body>
|
|
<a href="#main" class="visually-hidden-focusable">Skip to contents</a>
|
|
|
|
|
|
<nav class="navbar fixed-top navbar-light navbar-expand-lg bg-light"><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.4.1</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="active nav-item">
|
|
<a class="nav-link" href="../reference/index.html">Reference</a>
|
|
</li>
|
|
<li class="nav-item dropdown">
|
|
<a href="#" class="nav-link dropdown-toggle" data-bs-toggle="dropdown" role="button" aria-expanded="false" aria-haspopup="true" id="dropdown-articles">Articles</a>
|
|
<div class="dropdown-menu" aria-labelledby="dropdown-articles">
|
|
<a class="dropdown-item" href="../articles/Database-creation.html">Database-creation</a>
|
|
<a class="dropdown-item" href="../articles/Introduction.html">Introduction</a>
|
|
<a class="dropdown-item" href="../articles/Shiny-app.html">Shiny-app</a>
|
|
</div>
|
|
</li>
|
|
<li class="nav-item">
|
|
<a class="nav-link" href="../news/index.html">Changelog</a>
|
|
</li>
|
|
</ul><form class="form-inline my-2 my-lg-0" role="search">
|
|
<input type="search" class="form-control me-sm-2" aria-label="Toggle navigation" name="search-input" data-search-index="../search.json" id="search-input" placeholder="Search for" autocomplete="off"></form>
|
|
|
|
<ul class="navbar-nav"><li class="nav-item">
|
|
<a class="external-link nav-link" href="https://github.com/agdamsbo/REDCapCAST/" aria-label="github">
|
|
<span class="fab fa fab fa-github fa-lg"></span>
|
|
|
|
</a>
|
|
</li>
|
|
</ul></div>
|
|
|
|
|
|
</div>
|
|
</nav><div class="container template-reference-index">
|
|
<div class="row">
|
|
<main id="main" class="col-md-9"><div class="page-header">
|
|
<img src="../logo.png" class="logo" alt=""><h1>Function reference</h1>
|
|
</div>
|
|
|
|
<div class="section level2">
|
|
<h2 id="all-functions">All functions<a class="anchor" aria-label="anchor" href="#all-functions"></a></h2>
|
|
|
|
|
|
|
|
|
|
</div><div id="" class="section level2">
|
|
|
|
|
|
|
|
|
|
<dl><dt>
|
|
|
|
<code><a href="REDCap_split.html">REDCap_split()</a></code>
|
|
</dt>
|
|
<dd>Split REDCap repeating instruments table into multiple tables</dd>
|
|
</dl><dl><dt>
|
|
|
|
<code><a href="clean_redcap_name.html">clean_redcap_name()</a></code>
|
|
</dt>
|
|
<dd>clean_redcap_name</dd>
|
|
</dl><dl><dt>
|
|
|
|
<code><a href="d2w.html">d2w()</a></code>
|
|
</dt>
|
|
<dd>Convert single digits to words</dd>
|
|
</dl><dl><dt>
|
|
|
|
<code><a href="ds2dd.html">ds2dd()</a></code>
|
|
</dt>
|
|
<dd>(DEPRECATED) Data set to data dictionary function</dd>
|
|
</dl><dl><dt>
|
|
|
|
<code><a href="ds2dd_detailed.html">ds2dd_detailed()</a></code>
|
|
</dt>
|
|
<dd>Extract data from stata file for data dictionary</dd>
|
|
</dl><dl><dt>
|
|
|
|
<code><a href="easy_redcap.html">easy_redcap()</a></code>
|
|
</dt>
|
|
<dd>Secure API key storage and data acquisition in one</dd>
|
|
</dl><dl><dt>
|
|
|
|
<code><a href="file_extension.html">file_extension()</a></code>
|
|
</dt>
|
|
<dd>Helper to import files correctly</dd>
|
|
</dl><dl><dt>
|
|
|
|
<code><a href="focused_metadata.html">focused_metadata()</a></code>
|
|
</dt>
|
|
<dd>focused_metadata</dd>
|
|
</dl><dl><dt>
|
|
|
|
<code><a href="get_api_key.html">get_api_key()</a></code>
|
|
</dt>
|
|
<dd>Retrieve project API key if stored, if not, set and retrieve</dd>
|
|
</dl><dl><dt>
|
|
|
|
<code><a href="get_id_name.html">get_id_name()</a></code>
|
|
</dt>
|
|
<dd>Get the id name</dd>
|
|
</dl><dl><dt>
|
|
|
|
<code><a href="guess_time_only_filter.html">guess_time_only_filter()</a></code>
|
|
</dt>
|
|
<dd>Try at determining which are true time only variables</dd>
|
|
</dl><dl><dt>
|
|
|
|
<code><a href="hms2character.html">hms2character()</a></code>
|
|
</dt>
|
|
<dd>Change "hms" to "character" for REDCap upload.</dd>
|
|
</dl><dl><dt>
|
|
|
|
<code><a href="is_repeated_longitudinal.html">is_repeated_longitudinal()</a></code>
|
|
</dt>
|
|
<dd>Test if repeatable or longitudinal</dd>
|
|
</dl><dl><dt>
|
|
|
|
<code><a href="mark_complete.html">mark_complete()</a></code>
|
|
</dt>
|
|
<dd>Completion marking based on completed upload</dd>
|
|
</dl><dl><dt>
|
|
|
|
<code><a href="match_fields_to_form.html">match_fields_to_form()</a></code>
|
|
</dt>
|
|
<dd>Match fields to forms</dd>
|
|
</dl><dl><dt>
|
|
|
|
<code><a href="mtcars_redcap.html">mtcars_redcap</a></code>
|
|
</dt>
|
|
<dd>mtcars dataset slightly modified to use for Shiny app upload demonstration</dd>
|
|
</dl><dl><dt>
|
|
|
|
<code><a href="read_input.html">read_input()</a></code>
|
|
</dt>
|
|
<dd>Flexible file import based on extension</dd>
|
|
</dl><dl><dt>
|
|
|
|
<code><a href="read_redcap_instrument.html">read_redcap_instrument()</a></code>
|
|
</dt>
|
|
<dd>Convenience function to download complete instrument, using token storage
|
|
in keyring.</dd>
|
|
</dl><dl><dt>
|
|
|
|
<code><a href="read_redcap_tables.html">read_redcap_tables()</a></code>
|
|
</dt>
|
|
<dd>Download REDCap data</dd>
|
|
</dl><dl><dt>
|
|
|
|
<code><a href="redcap_wider.html">redcap_wider()</a></code>
|
|
</dt>
|
|
<dd>Redcap Wider</dd>
|
|
</dl><dl><dt>
|
|
|
|
<code><a href="redcapcast_data.html">redcapcast_data</a></code>
|
|
</dt>
|
|
<dd>Data set for demonstration</dd>
|
|
</dl><dl><dt>
|
|
|
|
<code><a href="redcapcast_meta.html">redcapcast_meta</a></code>
|
|
</dt>
|
|
<dd>REDCap metadata from data base</dd>
|
|
</dl><dl><dt>
|
|
|
|
<code><a href="sanitize_split.html">sanitize_split()</a></code>
|
|
</dt>
|
|
<dd>Sanitize list of data frames</dd>
|
|
</dl><dl><dt>
|
|
|
|
<code><a href="server_factory.html">server_factory()</a></code>
|
|
</dt>
|
|
<dd>Shiny server factory</dd>
|
|
</dl><dl><dt>
|
|
|
|
<code><a href="shiny_cast.html">shiny_cast()</a></code>
|
|
</dt>
|
|
<dd>Launch the included Shiny-app for database casting and upload</dd>
|
|
</dl><dl><dt>
|
|
|
|
<code><a href="split_non_repeating_forms.html">split_non_repeating_forms()</a></code>
|
|
</dt>
|
|
<dd>Split a data frame into separate tables for each form</dd>
|
|
</dl><dl><dt>
|
|
|
|
<code><a href="strsplitx.html">strsplitx()</a></code>
|
|
</dt>
|
|
<dd>Extended string splitting</dd>
|
|
</dl><dl><dt>
|
|
|
|
<code><a href="time_only_correction.html">time_only_correction()</a></code>
|
|
</dt>
|
|
<dd>Correction based on time_only_filter function</dd>
|
|
</dl><dl><dt>
|
|
|
|
<code><a href="ui_factory.html">ui_factory()</a></code>
|
|
</dt>
|
|
<dd>UI factory for shiny app</dd>
|
|
</dl></div>
|
|
</main></div>
|
|
|
|
|
|
<footer><div class="pkgdown-footer-left">
|
|
<p></p><p>Developed by Andreas Gammelgaard Damsbo, Paul Egeler.</p>
|
|
</div>
|
|
|
|
<div class="pkgdown-footer-right">
|
|
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p>
|
|
</div>
|
|
|
|
</footer></div>
|
|
|
|
|
|
|
|
|
|
|
|
</body></html>
|
|
|