mirror of
https://github.com/agdamsbo/REDCapCAST.git
synced 2024-12-03 17:51:52 +01:00
156 lines
10 KiB
HTML
156 lines
10 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>Download REDCap data — read_redcap_tables • 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="Download REDCap data — read_redcap_tables"><meta name="description" content="Implementation of passed on to REDCap_split with a focused
|
|
data acquisition approach using passed on to redcap_read and
|
|
only downloading specified fields, forms and/or events using the built-in
|
|
focused_metadata including some clean-up.
|
|
Works with classical and longitudinal projects with or without repeating
|
|
instruments.
|
|
Will preserve metadata in the data.frames as labels."><meta property="og:description" content="Implementation of passed on to REDCap_split with a focused
|
|
data acquisition approach using passed on to redcap_read and
|
|
only downloading specified fields, forms and/or events using the built-in
|
|
focused_metadata including some clean-up.
|
|
Works with classical and longitudinal projects with or without repeating
|
|
instruments.
|
|
Will preserve metadata in the data.frames as labels."><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.12.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="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>Download REDCap data</h1>
|
|
<small class="dont-index">Source: <a href="https://github.com/agdamsbo/REDCapCAST/blob/v24.12.1/R/read_redcap_tables.R" class="external-link"><code>R/read_redcap_tables.R</code></a></small>
|
|
<div class="d-none name"><code>read_redcap_tables.Rd</code></div>
|
|
</div>
|
|
|
|
<div class="ref-description section level2">
|
|
<p>Implementation of passed on to <a href="REDCap_split.html">REDCap_split</a> with a focused
|
|
data acquisition approach using passed on to <a href="https://ouhscbbmc.github.io/REDCapR/reference/redcap_read.html" class="external-link">redcap_read</a> and
|
|
only downloading specified fields, forms and/or events using the built-in
|
|
focused_metadata including some clean-up.
|
|
Works with classical and longitudinal projects with or without repeating
|
|
instruments.
|
|
Will preserve metadata in the data.frames as labels.</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">read_redcap_tables</span><span class="op">(</span></span>
|
|
<span> <span class="va">uri</span>,</span>
|
|
<span> <span class="va">token</span>,</span>
|
|
<span> records <span class="op">=</span> <span class="cn">NULL</span>,</span>
|
|
<span> fields <span class="op">=</span> <span class="cn">NULL</span>,</span>
|
|
<span> events <span class="op">=</span> <span class="cn">NULL</span>,</span>
|
|
<span> forms <span class="op">=</span> <span class="cn">NULL</span>,</span>
|
|
<span> raw_or_label <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">"raw"</span>, <span class="st">"label"</span>, <span class="st">"both"</span><span class="op">)</span>,</span>
|
|
<span> split_forms <span class="op">=</span> <span class="st">"all"</span>,</span>
|
|
<span> <span class="va">...</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-uri">uri<a class="anchor" aria-label="anchor" href="#arg-uri"></a></dt>
|
|
<dd><p>REDCap database API uri</p></dd>
|
|
|
|
|
|
<dt id="arg-token">token<a class="anchor" aria-label="anchor" href="#arg-token"></a></dt>
|
|
<dd><p>API token</p></dd>
|
|
|
|
|
|
<dt id="arg-records">records<a class="anchor" aria-label="anchor" href="#arg-records"></a></dt>
|
|
<dd><p>records to download</p></dd>
|
|
|
|
|
|
<dt id="arg-fields">fields<a class="anchor" aria-label="anchor" href="#arg-fields"></a></dt>
|
|
<dd><p>fields to download</p></dd>
|
|
|
|
|
|
<dt id="arg-events">events<a class="anchor" aria-label="anchor" href="#arg-events"></a></dt>
|
|
<dd><p>events to download</p></dd>
|
|
|
|
|
|
<dt id="arg-forms">forms<a class="anchor" aria-label="anchor" href="#arg-forms"></a></dt>
|
|
<dd><p>forms to download</p></dd>
|
|
|
|
|
|
<dt id="arg-raw-or-label">raw_or_label<a class="anchor" aria-label="anchor" href="#arg-raw-or-label"></a></dt>
|
|
<dd><p>raw or label tags. Can be "raw", "label" or "both".</p>
|
|
<p>* "raw": Standard <a href="https://ouhscbbmc.github.io/REDCapR/reference/redcap_read.html" class="external-link">redcap_read</a> method to get raw values.
|
|
* "label": Standard <a href="https://ouhscbbmc.github.io/REDCapR/reference/redcap_read.html" class="external-link">redcap_read</a> method to get label values.
|
|
* "both": Get raw values with REDCap labels applied as labels. Use
|
|
<a href="as_factor.html">as_factor</a> to format factors with original labels and use
|
|
the `gtsummary` package functions like <a href="https://www.danieldsjoberg.com/gtsummary/reference/tbl_summary.html" class="external-link">tbl_summary</a> to
|
|
easily get beautiful tables with original labels from REDCap. Use
|
|
<a href="fct_drop.html">fct_drop</a> to drop empty levels.</p></dd>
|
|
|
|
|
|
<dt id="arg-split-forms">split_forms<a class="anchor" aria-label="anchor" href="#arg-split-forms"></a></dt>
|
|
<dd><p>Whether to split "repeating" or "all" forms, default is
|
|
all.</p></dd>
|
|
|
|
|
|
<dt id="arg--">...<a class="anchor" aria-label="anchor" href="#arg--"></a></dt>
|
|
<dd><p>passed on to <a href="https://ouhscbbmc.github.io/REDCapR/reference/redcap_read.html" class="external-link">redcap_read</a></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 instruments</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"># Examples will be provided later</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>
|
|
|