2023-06-30 10:56:53 +02:00
<!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" > < meta name = "description" content = "Implementation of REDCap_split with a focused data acquisition approach using
2024-01-09 10:37:35 +01:00
REDCapR::redcap_read and only downloading specified fields, forms and/or
2023-06-30 10:56:53 +02:00
events using the built-in focused_metadata including some clean-up.
2024-01-09 10:37:35 +01:00
Works with classical and longitudinal projects with or without repeating
instruments.">< 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 > <!-- 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 = "Download REDCap data — read_redcap_tables" > < meta property = "og:description" content = "Implementation of REDCap_split with a focused data acquisition approach using
REDCapR::redcap_read and only downloading specified fields, forms and/or
2023-06-30 10:56:53 +02:00
events using the built-in focused_metadata including some clean-up.
2024-01-09 10:37:35 +01:00
Works with classical and longitudinal projects with or without repeating
instruments.">< 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]>
2023-06-30 10:56:53 +02:00
< 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 >
2024-01-18 15:08:43 +01:00
< small class = "nav-text text-muted me-auto" data-bs-toggle = "tooltip" data-bs-placement = "bottom" title = "" > 24.1.2< / small >
2023-06-30 10:56:53 +02: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" >
< 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/Introduction.html" > Introduction< / 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-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/HEAD/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 REDCap_split with a focused data acquisition approach using
2024-01-09 10:37:35 +01:00
REDCapR::redcap_read and only downloading specified fields, forms and/or
2023-06-30 10:56:53 +02:00
events using the built-in focused_metadata including some clean-up.
2024-01-09 10:37:35 +01:00
Works with classical and longitudinal projects with or without repeating
instruments.< / p >
2023-06-30 10:56:53 +02:00
< / 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 = "st" > "label"< / span > ,< / span >
< span > split_forms < span class = "op" > =< / span > < span class = "st" > "all"< / span > ,< / span >
< span > generics < 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" > "record_id"< / span > , < span class = "st" > "redcap_event_name"< / span > , < span class = "st" > "redcap_repeat_instrument"< / span > ,< / span >
< span > < span class = "st" > "redcap_repeat_instance"< / span > < span class = "op" > )< / 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 > uri< / dt >
< dd > < p > REDCap database uri< / p > < / dd >
< dt > token< / dt >
< dd > < p > API token< / p > < / dd >
< dt > records< / dt >
< dd > < p > records to download< / p > < / dd >
< dt > fields< / dt >
< dd > < p > fields to download< / p > < / dd >
< dt > events< / dt >
< dd > < p > events to download< / p > < / dd >
< dt > forms< / dt >
< dd > < p > forms to download< / p > < / dd >
< dt > raw_or_label< / dt >
< dd > < p > raw or label tags< / p > < / dd >
< dt > split_forms< / dt >
< dd > < p > Whether to split "repeating" or "all" forms, default is
all.< / p > < / dd >
< dt > generics< / dt >
< dd > < p > vector of auto-generated generic variable names to
ignore when discarding empty rows< / 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 >
< span class = "r-in" > < / span >
< / code > < / pre > < / div >
< / div >
< / main > < aside class = "col-md-3" > < nav id = "toc" > < h2 > On this page< / h2 >
< / nav > < / aside > < / 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 >
