andreas/REDCapCAST
1
0
Fork 0
mirror of https://github.com/agdamsbo/REDCapCAST.git synced 2024-12-05 02:21:54 +01:00
Code Issues Packages Projects Releases Wiki Activity
826994faef
REDCapCAST/reference/easy_redcap.html

96 lines
6.7 KiB
HTML
Raw Normal View History

Deploying to gh-pages from @ agdamsbo/REDCapCAST@8717542e9242f7abeef6f5b6e375e91ed947eace 🚀
2023-12-20 09:33:52 +01:00
<!DOCTYPE html>
Deploying to gh-pages from @ agdamsbo/REDCapCAST@927d485739a4c9bedf9378b2c6244794560e9667 🚀
2024-11-18 08:28:35 +01:00
<!-- 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>Secure API key storage and data acquisition in one — easy_redcap • 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="Secure API key storage and data acquisition in one — easy_redcap"><meta name="description" content="Secure API key storage and data acquisition in one"><meta property="og:description" content="Secure API key storage and data acquisition in one"><meta property="og:image" content="https://agdamsbo.github.io/REDCapCAST/logo.png"></head><body>
Deploying to gh-pages from @ agdamsbo/REDCapCAST@8717542e9242f7abeef6f5b6e375e91ed947eace 🚀
2023-12-20 09:33:52 +01:00
<a href="#main" class="visually-hidden-focusable">Skip to contents</a>
Deploying to gh-pages from @ agdamsbo/REDCapCAST@c7ab477203eb62f1ea6b44d5d874fc2e2b2827b6 🚀
2024-09-05 13:02:42 +02:00
<nav class="navbar navbar-expand-lg fixed-top bg-light" data-bs-theme="light" aria-label="Site navigation"><div class="container">
Deploying to gh-pages from @ agdamsbo/REDCapCAST@8717542e9242f7abeef6f5b6e375e91ed947eace 🚀
2023-12-20 09:33:52 +01:00
<a class="navbar-brand me-2" href="../index.html">REDCapCAST</a>
Deploying to gh-pages from @ agdamsbo/REDCapCAST@45315080c596d3c1ea5f2e815ef27d2a50230326 🚀
2024-11-25 10:26:30 +01:00
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">24.11.3</small>
Deploying to gh-pages from @ agdamsbo/REDCapCAST@c7ab477203eb62f1ea6b44d5d874fc2e2b2827b6 🚀
2024-09-05 13:02:42 +02:00
Deploying to gh-pages from @ agdamsbo/REDCapCAST@8717542e9242f7abeef6f5b6e375e91ed947eace 🚀
2023-12-20 09:33:52 +01:00
<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">
Deploying to gh-pages from @ agdamsbo/REDCapCAST@4e7af7d01fe0f9b226816ef11f4d5551bfa5f1d2 🚀
2024-11-18 16:51:34 +01:00
<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>
Deploying to gh-pages from @ agdamsbo/REDCapCAST@8717542e9242f7abeef6f5b6e375e91ed947eace 🚀
2023-12-20 09:33:52 +01:00
<li class="nav-item dropdown">
Deploying to gh-pages from @ agdamsbo/REDCapCAST@c7ab477203eb62f1ea6b44d5d874fc2e2b2827b6 🚀
2024-09-05 13:02:42 +02:00
<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>
Deploying to gh-pages from @ agdamsbo/REDCapCAST@8717542e9242f7abeef6f5b6e375e91ed947eace 🚀
2023-12-20 09:33:52 +01:00
</ul></div>
Deploying to gh-pages from @ agdamsbo/REDCapCAST@c7ab477203eb62f1ea6b44d5d874fc2e2b2827b6 🚀
2024-09-05 13:02:42 +02:00
Deploying to gh-pages from @ agdamsbo/REDCapCAST@8717542e9242f7abeef6f5b6e375e91ed947eace 🚀
2023-12-20 09:33:52 +01:00
</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>Secure API key storage and data acquisition in one</h1>
Deploying to gh-pages from @ agdamsbo/REDCapCAST@45315080c596d3c1ea5f2e815ef27d2a50230326 🚀
2024-11-25 13:40:00 +01:00
<small class="dont-index">Source: <a href="https://github.com/agdamsbo/REDCapCAST/blob/v24.11.3/R/easy_redcap.R" class="external-link"><code>R/easy_redcap.R</code></a></small>
Deploying to gh-pages from @ agdamsbo/REDCapCAST@8717542e9242f7abeef6f5b6e375e91ed947eace 🚀
2023-12-20 09:33:52 +01:00
<div class="d-none name"><code>easy_redcap.Rd</code></div>
</div>
<div class="ref-description section level2">
<p>Secure API key storage and data acquisition in one</p>
</div>
<div class="section level2">
<h2 id="ref-usage">Usage<a class="anchor" aria-label="anchor" href="#ref-usage"></a></h2>
Deploying to gh-pages from @ agdamsbo/REDCapCAST@c47f5a9d0781522303461953bcf44d009d5d05dc 🚀
2024-02-05 14:58:19 +01:00
<div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">easy_redcap</span><span class="op">(</span><span class="va">project.name</span>, widen.data <span class="op">=</span> <span class="cn">TRUE</span>, <span class="va">uri</span>, <span class="va">...</span><span class="op">)</span></span></code></pre></div>
Deploying to gh-pages from @ agdamsbo/REDCapCAST@8717542e9242f7abeef6f5b6e375e91ed947eace 🚀
2023-12-20 09:33:52 +01:00
</div>
<div class="section level2">
<h2 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h2>
Deploying to gh-pages from @ agdamsbo/REDCapCAST@c7ab477203eb62f1ea6b44d5d874fc2e2b2827b6 🚀
2024-09-05 13:02:42 +02:00
<dl><dt id="arg-project-name">project.name<a class="anchor" aria-label="anchor" href="#arg-project-name"></a></dt>
Deploying to gh-pages from @ agdamsbo/REDCapCAST@8717542e9242f7abeef6f5b6e375e91ed947eace 🚀
2023-12-20 09:33:52 +01:00
<dd><p>The name of the current project (for key storage with
Deploying to gh-pages from @ agdamsbo/REDCapCAST@e6a7ef3e5aaa2c80ce6cd1d3cba659661840e440 🚀
2024-02-06 14:27:54 +01:00
`keyring::key_set()`, using the default keyring)</p></dd>
Deploying to gh-pages from @ agdamsbo/REDCapCAST@8717542e9242f7abeef6f5b6e375e91ed947eace 🚀
2023-12-20 09:33:52 +01:00
Deploying to gh-pages from @ agdamsbo/REDCapCAST@c7ab477203eb62f1ea6b44d5d874fc2e2b2827b6 🚀
2024-09-05 13:02:42 +02:00
<dt id="arg-widen-data">widen.data<a class="anchor" aria-label="anchor" href="#arg-widen-data"></a></dt>
Deploying to gh-pages from @ agdamsbo/REDCapCAST@8717542e9242f7abeef6f5b6e375e91ed947eace 🚀
2023-12-20 09:33:52 +01:00
<dd><p>argument to widen the exported data</p></dd>
Deploying to gh-pages from @ agdamsbo/REDCapCAST@c7ab477203eb62f1ea6b44d5d874fc2e2b2827b6 🚀
2024-09-05 13:02:42 +02:00
<dt id="arg-uri">uri<a class="anchor" aria-label="anchor" href="#arg-uri"></a></dt>
Deploying to gh-pages from @ agdamsbo/REDCapCAST@c47f5a9d0781522303461953bcf44d009d5d05dc 🚀
2024-02-05 14:58:19 +01:00
<dd><p>REDCap database API uri</p></dd>
Deploying to gh-pages from @ agdamsbo/REDCapCAST@c7ab477203eb62f1ea6b44d5d874fc2e2b2827b6 🚀
2024-09-05 13:02:42 +02:00
<dt id="arg--">...<a class="anchor" aria-label="anchor" href="#arg--"></a></dt>
Deploying to gh-pages from @ agdamsbo/REDCapCAST@8717542e9242f7abeef6f5b6e375e91ed947eace 🚀
2023-12-20 09:33:52 +01:00
<dd><p>arguments passed on to `REDCapCAST::read_redcap_tables()`</p></dd>
</dl></div>
<div class="section level2">
<h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
Deploying to gh-pages from @ agdamsbo/REDCapCAST@c7ab477203eb62f1ea6b44d5d874fc2e2b2827b6 🚀
2024-09-05 13:02:42 +02:00
<p>data.frame or list depending on widen.data</p>
Deploying to gh-pages from @ agdamsbo/REDCapCAST@8717542e9242f7abeef6f5b6e375e91ed947eace 🚀
2023-12-20 09:33:52 +01:00
</div>
Deploying to gh-pages from @ agdamsbo/REDCapCAST@c7ab477203eb62f1ea6b44d5d874fc2e2b2827b6 🚀
2024-09-05 13:02:42 +02:00
</main><aside class="col-md-3"><nav id="toc" aria-label="Table of contents"><h2>On this page</h2>
Deploying to gh-pages from @ agdamsbo/REDCapCAST@8717542e9242f7abeef6f5b6e375e91ed947eace 🚀
2023-12-20 09:33:52 +01:00
</nav></aside></div>
<footer><div class="pkgdown-footer-left">
Deploying to gh-pages from @ agdamsbo/REDCapCAST@e26efd01b4b8cb25860912571bf2535e9ff6bcbd 🚀
2024-05-23 11:55:51 +02:00
<p>Developed by Andreas Gammelgaard Damsbo, Paul Egeler.</p>
Deploying to gh-pages from @ agdamsbo/REDCapCAST@8717542e9242f7abeef6f5b6e375e91ed947eace 🚀
2023-12-20 09:33:52 +01:00
</div>
<div class="pkgdown-footer-right">
Deploying to gh-pages from @ agdamsbo/REDCapCAST@e9c8eced50e9bdd73b00ca5c11778a4a96a916bb 🚀
2024-10-02 10:15:20 +02:00
<p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.1.1.</p>
Deploying to gh-pages from @ agdamsbo/REDCapCAST@8717542e9242f7abeef6f5b6e375e91ed947eace 🚀
2023-12-20 09:33:52 +01:00
</div>
</footer></div>
Deploying to gh-pages from @ agdamsbo/REDCapCAST@c7ab477203eb62f1ea6b44d5d874fc2e2b2827b6 🚀
2024-09-05 13:02:42 +02:00
Deploying to gh-pages from @ agdamsbo/REDCapCAST@8717542e9242f7abeef6f5b6e375e91ed947eace 🚀
2023-12-20 09:33:52 +01:00
</body></html>
Reference in New Issue Copy Permalink