andreas/REDCapCAST
1
0
Fork 0
mirror of https://github.com/agdamsbo/REDCapCAST.git synced 2024-11-23 21:50:21 +01:00
Code Issues Packages Projects Releases Wiki Activity
270ed5a956
REDCapCAST/articles/Database-creation.html

915 lines
42 KiB
HTML
Raw Blame History

<!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>Database-creation • 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="Database-creation">
</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="nav-item"><a class="nav-link" href="../reference/index.html">Reference</a></li>
<li class="active 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-article">
<div class="row">
<main id="main" class="col-md-9"><div class="page-header">
<img src="../logo.png" class="logo" alt=""><h1>Database-creation</h1>
<small class="dont-index">Source: <a href="https://github.com/agdamsbo/REDCapCAST/blob/main/vignettes/Database-creation.Rmd" class="external-link"><code>vignettes/Database-creation.Rmd</code></a></small>
<div class="d-none name"><code>Database-creation.Rmd</code></div>
</div>
<div class="sourceCode" id="cb1"><pre class="downlit sourceCode r">
<code class="sourceCode R"><span><span class="kw"><a href="https://rdrr.io/r/base/library.html" class="external-link">library</a></span><span class="op">(</span><span class="va"><a href="https://github.com/agdamsbo/REDCapCAST" class="external-link">REDCapCAST</a></span><span class="op">)</span></span></code></pre></div>
<div class="section level2">
<h2 id="two-different-ways-to-create-a-data-base">Two different ways to create a data base<a class="anchor" aria-label="anchor" href="#two-different-ways-to-create-a-data-base"></a>
</h2>
<p><code>REDCapCAST</code> provides two approaches to creating a data
dictionary aimed at helping out in two different cases:</p>
<ol style="list-style-type: decimal">
<li><p>Easily create a REDCap data base from an existing data
set.</p></li>
<li><p>Create a table in Word describing a variables in a data base and
use this to create a data base.</p></li>
</ol>
<p>In the following I will try to come with a few suggestions on how to
use these approaches.</p>
<div class="section level3">
<h3 id="easy-data-set-to-data-base-workflow">Easy data set to data base workflow<a class="anchor" aria-label="anchor" href="#easy-data-set-to-data-base-workflow"></a>
</h3>
<p>The first iteration of a dataset to data dictionary function is the
<code><a href="../reference/ds2dd.html">ds2dd()</a></code>, which creates a very basic data dictionary with
all variables stored as text. This is sufficient for just storing old
datasets/spreadsheets securely in REDCap.</p>
<div class="sourceCode" id="cb2"><pre class="downlit sourceCode r">
<code class="sourceCode R"><span><span class="va">d1</span> <span class="op">&lt;-</span> <span class="va">mtcars</span> <span class="op">|&gt;</span></span>
<span> <span class="fu">dplyr</span><span class="fu">::</span><span class="fu"><a href="https://dplyr.tidyverse.org/reference/mutate.html" class="external-link">mutate</a></span><span class="op">(</span>record_id <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/seq.html" class="external-link">seq_len</a></span><span class="op">(</span><span class="fu">dplyr</span><span class="fu">::</span><span class="fu"><a href="https://dplyr.tidyverse.org/reference/context.html" class="external-link">n</a></span><span class="op">(</span><span class="op">)</span><span class="op">)</span><span class="op">)</span> <span class="op">|&gt;</span></span>
<span> <span class="fu"><a href="../reference/ds2dd.html">ds2dd</a></span><span class="op">(</span><span class="op">)</span> </span>
<span></span>
<span><span class="va">d1</span> <span class="op">|&gt;</span></span>
<span> <span class="fu">gt</span><span class="fu">::</span><span class="fu"><a href="https://gt.rstudio.com/reference/gt.html" class="external-link">gt</a></span><span class="op">(</span><span class="op">)</span></span></code></pre></div>
<div id="mwlefoodfi" style="padding-left:0px;padding-right:0px;padding-top:10px;padding-bottom:10px;overflow-x:auto;overflow-y:auto;width:auto;height:auto;">
<style>#mwlefoodfi table {
font-family: system-ui, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol', 'Noto Color Emoji';
-webkit-font-smoothing: antialiased;
-moz-osx-font-smoothing: grayscale;
}
#mwlefoodfi thead, #mwlefoodfi tbody, #mwlefoodfi tfoot, #mwlefoodfi tr, #mwlefoodfi td, #mwlefoodfi th {
border-style: none;
}
#mwlefoodfi p {
margin: 0;
padding: 0;
}
#mwlefoodfi .gt_table {
display: table;
border-collapse: collapse;
line-height: normal;
margin-left: auto;
margin-right: auto;
color: #333333;
font-size: 16px;
font-weight: normal;
font-style: normal;
background-color: #FFFFFF;
width: auto;
border-top-style: solid;
border-top-width: 2px;
border-top-color: #A8A8A8;
border-right-style: none;
border-right-width: 2px;
border-right-color: #D3D3D3;
border-bottom-style: solid;
border-bottom-width: 2px;
border-bottom-color: #A8A8A8;
border-left-style: none;
border-left-width: 2px;
border-left-color: #D3D3D3;
}
#mwlefoodfi .gt_caption {
padding-top: 4px;
padding-bottom: 4px;
}
#mwlefoodfi .gt_title {
color: #333333;
font-size: 125%;
font-weight: initial;
padding-top: 4px;
padding-bottom: 4px;
padding-left: 5px;
padding-right: 5px;
border-bottom-color: #FFFFFF;
border-bottom-width: 0;
}
#mwlefoodfi .gt_subtitle {
color: #333333;
font-size: 85%;
font-weight: initial;
padding-top: 3px;
padding-bottom: 5px;
padding-left: 5px;
padding-right: 5px;
border-top-color: #FFFFFF;
border-top-width: 0;
}
#mwlefoodfi .gt_heading {
background-color: #FFFFFF;
text-align: center;
border-bottom-color: #FFFFFF;
border-left-style: none;
border-left-width: 1px;
border-left-color: #D3D3D3;
border-right-style: none;
border-right-width: 1px;
border-right-color: #D3D3D3;
}
#mwlefoodfi .gt_bottom_border {
border-bottom-style: solid;
border-bottom-width: 2px;
border-bottom-color: #D3D3D3;
}
#mwlefoodfi .gt_col_headings {
border-top-style: solid;
border-top-width: 2px;
border-top-color: #D3D3D3;
border-bottom-style: solid;
border-bottom-width: 2px;
border-bottom-color: #D3D3D3;
border-left-style: none;
border-left-width: 1px;
border-left-color: #D3D3D3;
border-right-style: none;
border-right-width: 1px;
border-right-color: #D3D3D3;
}
#mwlefoodfi .gt_col_heading {
color: #333333;
background-color: #FFFFFF;
font-size: 100%;
font-weight: normal;
text-transform: inherit;
border-left-style: none;
border-left-width: 1px;
border-left-color: #D3D3D3;
border-right-style: none;
border-right-width: 1px;
border-right-color: #D3D3D3;
vertical-align: bottom;
padding-top: 5px;
padding-bottom: 6px;
padding-left: 5px;
padding-right: 5px;
overflow-x: hidden;
}
#mwlefoodfi .gt_column_spanner_outer {
color: #333333;
background-color: #FFFFFF;
font-size: 100%;
font-weight: normal;
text-transform: inherit;
padding-top: 0;
padding-bottom: 0;
padding-left: 4px;
padding-right: 4px;
}
#mwlefoodfi .gt_column_spanner_outer:first-child {
padding-left: 0;
}
#mwlefoodfi .gt_column_spanner_outer:last-child {
padding-right: 0;
}
#mwlefoodfi .gt_column_spanner {
border-bottom-style: solid;
border-bottom-width: 2px;
border-bottom-color: #D3D3D3;
vertical-align: bottom;
padding-top: 5px;
padding-bottom: 5px;
overflow-x: hidden;
display: inline-block;
width: 100%;
}
#mwlefoodfi .gt_spanner_row {
border-bottom-style: hidden;
}
#mwlefoodfi .gt_group_heading {
padding-top: 8px;
padding-bottom: 8px;
padding-left: 5px;
padding-right: 5px;
color: #333333;
background-color: #FFFFFF;
font-size: 100%;
font-weight: initial;
text-transform: inherit;
border-top-style: solid;
border-top-width: 2px;
border-top-color: #D3D3D3;
border-bottom-style: solid;
border-bottom-width: 2px;
border-bottom-color: #D3D3D3;
border-left-style: none;
border-left-width: 1px;
border-left-color: #D3D3D3;
border-right-style: none;
border-right-width: 1px;
border-right-color: #D3D3D3;
vertical-align: middle;
text-align: left;
}
#mwlefoodfi .gt_empty_group_heading {
padding: 0.5px;
color: #333333;
background-color: #FFFFFF;
font-size: 100%;
font-weight: initial;
border-top-style: solid;
border-top-width: 2px;
border-top-color: #D3D3D3;
border-bottom-style: solid;
border-bottom-width: 2px;
border-bottom-color: #D3D3D3;
vertical-align: middle;
}
#mwlefoodfi .gt_from_md > :first-child {
margin-top: 0;
}
#mwlefoodfi .gt_from_md > :last-child {
margin-bottom: 0;
}
#mwlefoodfi .gt_row {
padding-top: 8px;
padding-bottom: 8px;
padding-left: 5px;
padding-right: 5px;
margin: 10px;
border-top-style: solid;
border-top-width: 1px;
border-top-color: #D3D3D3;
border-left-style: none;
border-left-width: 1px;
border-left-color: #D3D3D3;
border-right-style: none;
border-right-width: 1px;
border-right-color: #D3D3D3;
vertical-align: middle;
overflow-x: hidden;
}
#mwlefoodfi .gt_stub {
color: #333333;
background-color: #FFFFFF;
font-size: 100%;
font-weight: initial;
text-transform: inherit;
border-right-style: solid;
border-right-width: 2px;
border-right-color: #D3D3D3;
padding-left: 5px;
padding-right: 5px;
}
#mwlefoodfi .gt_stub_row_group {
color: #333333;
background-color: #FFFFFF;
font-size: 100%;
font-weight: initial;
text-transform: inherit;
border-right-style: solid;
border-right-width: 2px;
border-right-color: #D3D3D3;
padding-left: 5px;
padding-right: 5px;
vertical-align: top;
}
#mwlefoodfi .gt_row_group_first td {
border-top-width: 2px;
}
#mwlefoodfi .gt_row_group_first th {
border-top-width: 2px;
}
#mwlefoodfi .gt_summary_row {
color: #333333;
background-color: #FFFFFF;
text-transform: inherit;
padding-top: 8px;
padding-bottom: 8px;
padding-left: 5px;
padding-right: 5px;
}
#mwlefoodfi .gt_first_summary_row {
border-top-style: solid;
border-top-color: #D3D3D3;
}
#mwlefoodfi .gt_first_summary_row.thick {
border-top-width: 2px;
}
#mwlefoodfi .gt_last_summary_row {
padding-top: 8px;
padding-bottom: 8px;
padding-left: 5px;
padding-right: 5px;
border-bottom-style: solid;
border-bottom-width: 2px;
border-bottom-color: #D3D3D3;
}
#mwlefoodfi .gt_grand_summary_row {
color: #333333;
background-color: #FFFFFF;
text-transform: inherit;
padding-top: 8px;
padding-bottom: 8px;
padding-left: 5px;
padding-right: 5px;
}
#mwlefoodfi .gt_first_grand_summary_row {
padding-top: 8px;
padding-bottom: 8px;
padding-left: 5px;
padding-right: 5px;
border-top-style: double;
border-top-width: 6px;
border-top-color: #D3D3D3;
}
#mwlefoodfi .gt_last_grand_summary_row_top {
padding-top: 8px;
padding-bottom: 8px;
padding-left: 5px;
padding-right: 5px;
border-bottom-style: double;
border-bottom-width: 6px;
border-bottom-color: #D3D3D3;
}
#mwlefoodfi .gt_striped {
background-color: rgba(128, 128, 128, 0.05);
}
#mwlefoodfi .gt_table_body {
border-top-style: solid;
border-top-width: 2px;
border-top-color: #D3D3D3;
border-bottom-style: solid;
border-bottom-width: 2px;
border-bottom-color: #D3D3D3;
}
#mwlefoodfi .gt_footnotes {
color: #333333;
background-color: #FFFFFF;
border-bottom-style: none;
border-bottom-width: 2px;
border-bottom-color: #D3D3D3;
border-left-style: none;
border-left-width: 2px;
border-left-color: #D3D3D3;
border-right-style: none;
border-right-width: 2px;
border-right-color: #D3D3D3;
}
#mwlefoodfi .gt_footnote {
margin: 0px;
font-size: 90%;
padding-top: 4px;
padding-bottom: 4px;
padding-left: 5px;
padding-right: 5px;
}
#mwlefoodfi .gt_sourcenotes {
color: #333333;
background-color: #FFFFFF;
border-bottom-style: none;
border-bottom-width: 2px;
border-bottom-color: #D3D3D3;
border-left-style: none;
border-left-width: 2px;
border-left-color: #D3D3D3;
border-right-style: none;
border-right-width: 2px;
border-right-color: #D3D3D3;
}
#mwlefoodfi .gt_sourcenote {
font-size: 90%;
padding-top: 4px;
padding-bottom: 4px;
padding-left: 5px;
padding-right: 5px;
}
#mwlefoodfi .gt_left {
text-align: left;
}
#mwlefoodfi .gt_center {
text-align: center;
}
#mwlefoodfi .gt_right {
text-align: right;
font-variant-numeric: tabular-nums;
}
#mwlefoodfi .gt_font_normal {
font-weight: normal;
}
#mwlefoodfi .gt_font_bold {
font-weight: bold;
}
#mwlefoodfi .gt_font_italic {
font-style: italic;
}
#mwlefoodfi .gt_super {
font-size: 65%;
}
#mwlefoodfi .gt_footnote_marks {
font-size: 75%;
vertical-align: 0.4em;
position: initial;
}
#mwlefoodfi .gt_asterisk {
font-size: 100%;
vertical-align: 0;
}
#mwlefoodfi .gt_indent_1 {
text-indent: 5px;
}
#mwlefoodfi .gt_indent_2 {
text-indent: 10px;
}
#mwlefoodfi .gt_indent_3 {
text-indent: 15px;
}
#mwlefoodfi .gt_indent_4 {
text-indent: 20px;
}
#mwlefoodfi .gt_indent_5 {
text-indent: 25px;
}
#mwlefoodfi .katex-display {
display: inline-flex !important;
margin-bottom: 0.75em !important;
}
#mwlefoodfi div.Reactable > div.rt-table > div.rt-thead > div.rt-tr.rt-tr-group-header > div.rt-th-group:after {
height: 0px !important;
}
</style>
<table class="table gt_table" data-quarto-disable-processing="false" data-quarto-bootstrap="false">
<thead><tr class="gt_col_headings">
<th class="gt_col_heading gt_columns_bottom_border gt_left" rowspan="1" colspan="1" scope="col" id="field_name">field_name</th>
<th class="gt_col_heading gt_columns_bottom_border gt_left" rowspan="1" colspan="1" scope="col" id="form_name">form_name</th>
<th class="gt_col_heading gt_columns_bottom_border gt_center" rowspan="1" colspan="1" scope="col" id="section_header">section_header</th>
<th class="gt_col_heading gt_columns_bottom_border gt_left" rowspan="1" colspan="1" scope="col" id="field_type">field_type</th>
<th class="gt_col_heading gt_columns_bottom_border gt_left" rowspan="1" colspan="1" scope="col" id="field_label">field_label</th>
<th class="gt_col_heading gt_columns_bottom_border gt_center" rowspan="1" colspan="1" scope="col" id="select_choices_or_calculations">select_choices_or_calculations</th>
<th class="gt_col_heading gt_columns_bottom_border gt_center" rowspan="1" colspan="1" scope="col" id="field_note">field_note</th>
<th class="gt_col_heading gt_columns_bottom_border gt_center" rowspan="1" colspan="1" scope="col" id="text_validation_type_or_show_slider_number">text_validation_type_or_show_slider_number</th>
<th class="gt_col_heading gt_columns_bottom_border gt_center" rowspan="1" colspan="1" scope="col" id="text_validation_min">text_validation_min</th>
<th class="gt_col_heading gt_columns_bottom_border gt_center" rowspan="1" colspan="1" scope="col" id="text_validation_max">text_validation_max</th>
<th class="gt_col_heading gt_columns_bottom_border gt_center" rowspan="1" colspan="1" scope="col" id="identifier">identifier</th>
<th class="gt_col_heading gt_columns_bottom_border gt_center" rowspan="1" colspan="1" scope="col" id="branching_logic">branching_logic</th>
<th class="gt_col_heading gt_columns_bottom_border gt_center" rowspan="1" colspan="1" scope="col" id="required_field">required_field</th>
<th class="gt_col_heading gt_columns_bottom_border gt_center" rowspan="1" colspan="1" scope="col" id="custom_alignment">custom_alignment</th>
<th class="gt_col_heading gt_columns_bottom_border gt_center" rowspan="1" colspan="1" scope="col" id="question_number">question_number</th>
<th class="gt_col_heading gt_columns_bottom_border gt_center" rowspan="1" colspan="1" scope="col" id="matrix_group_name">matrix_group_name</th>
<th class="gt_col_heading gt_columns_bottom_border gt_center" rowspan="1" colspan="1" scope="col" id="matrix_ranking">matrix_ranking</th>
<th class="gt_col_heading gt_columns_bottom_border gt_center" rowspan="1" colspan="1" scope="col" id="field_annotation">field_annotation</th>
</tr></thead>
<tbody class="gt_table_body">
<tr>
<td headers="field_name" class="gt_row gt_left">record_id</td>
<td headers="form_name" class="gt_row gt_left">basis</td>
<td headers="section_header" class="gt_row gt_center">NA</td>
<td headers="field_type" class="gt_row gt_left">text</td>
<td headers="field_label" class="gt_row gt_left">record_id</td>
<td headers="select_choices_or_calculations" class="gt_row gt_center">NA</td>
<td headers="field_note" class="gt_row gt_center">NA</td>
<td headers="text_validation_type_or_show_slider_number" class="gt_row gt_center">NA</td>
<td headers="text_validation_min" class="gt_row gt_center">NA</td>
<td headers="text_validation_max" class="gt_row gt_center">NA</td>
<td headers="identifier" class="gt_row gt_center">NA</td>
<td headers="branching_logic" class="gt_row gt_center">NA</td>
<td headers="required_field" class="gt_row gt_center">NA</td>
<td headers="custom_alignment" class="gt_row gt_center">NA</td>
<td headers="question_number" class="gt_row gt_center">NA</td>
<td headers="matrix_group_name" class="gt_row gt_center">NA</td>
<td headers="matrix_ranking" class="gt_row gt_center">NA</td>
<td headers="field_annotation" class="gt_row gt_center">NA</td>
</tr>
<tr>
<td headers="field_name" class="gt_row gt_left">mpg</td>
<td headers="form_name" class="gt_row gt_left">basis</td>
<td headers="section_header" class="gt_row gt_center">NA</td>
<td headers="field_type" class="gt_row gt_left">text</td>
<td headers="field_label" class="gt_row gt_left">mpg</td>
<td headers="select_choices_or_calculations" class="gt_row gt_center">NA</td>
<td headers="field_note" class="gt_row gt_center">NA</td>
<td headers="text_validation_type_or_show_slider_number" class="gt_row gt_center">NA</td>
<td headers="text_validation_min" class="gt_row gt_center">NA</td>
<td headers="text_validation_max" class="gt_row gt_center">NA</td>
<td headers="identifier" class="gt_row gt_center">NA</td>
<td headers="branching_logic" class="gt_row gt_center">NA</td>
<td headers="required_field" class="gt_row gt_center">NA</td>
<td headers="custom_alignment" class="gt_row gt_center">NA</td>
<td headers="question_number" class="gt_row gt_center">NA</td>
<td headers="matrix_group_name" class="gt_row gt_center">NA</td>
<td headers="matrix_ranking" class="gt_row gt_center">NA</td>
<td headers="field_annotation" class="gt_row gt_center">NA</td>
</tr>
<tr>
<td headers="field_name" class="gt_row gt_left">cyl</td>
<td headers="form_name" class="gt_row gt_left">basis</td>
<td headers="section_header" class="gt_row gt_center">NA</td>
<td headers="field_type" class="gt_row gt_left">text</td>
<td headers="field_label" class="gt_row gt_left">cyl</td>
<td headers="select_choices_or_calculations" class="gt_row gt_center">NA</td>
<td headers="field_note" class="gt_row gt_center">NA</td>
<td headers="text_validation_type_or_show_slider_number" class="gt_row gt_center">NA</td>
<td headers="text_validation_min" class="gt_row gt_center">NA</td>
<td headers="text_validation_max" class="gt_row gt_center">NA</td>
<td headers="identifier" class="gt_row gt_center">NA</td>
<td headers="branching_logic" class="gt_row gt_center">NA</td>
<td headers="required_field" class="gt_row gt_center">NA</td>
<td headers="custom_alignment" class="gt_row gt_center">NA</td>
<td headers="question_number" class="gt_row gt_center">NA</td>
<td headers="matrix_group_name" class="gt_row gt_center">NA</td>
<td headers="matrix_ranking" class="gt_row gt_center">NA</td>
<td headers="field_annotation" class="gt_row gt_center">NA</td>
</tr>
<tr>
<td headers="field_name" class="gt_row gt_left">disp</td>
<td headers="form_name" class="gt_row gt_left">basis</td>
<td headers="section_header" class="gt_row gt_center">NA</td>
<td headers="field_type" class="gt_row gt_left">text</td>
<td headers="field_label" class="gt_row gt_left">disp</td>
<td headers="select_choices_or_calculations" class="gt_row gt_center">NA</td>
<td headers="field_note" class="gt_row gt_center">NA</td>
<td headers="text_validation_type_or_show_slider_number" class="gt_row gt_center">NA</td>
<td headers="text_validation_min" class="gt_row gt_center">NA</td>
<td headers="text_validation_max" class="gt_row gt_center">NA</td>
<td headers="identifier" class="gt_row gt_center">NA</td>
<td headers="branching_logic" class="gt_row gt_center">NA</td>
<td headers="required_field" class="gt_row gt_center">NA</td>
<td headers="custom_alignment" class="gt_row gt_center">NA</td>
<td headers="question_number" class="gt_row gt_center">NA</td>
<td headers="matrix_group_name" class="gt_row gt_center">NA</td>
<td headers="matrix_ranking" class="gt_row gt_center">NA</td>
<td headers="field_annotation" class="gt_row gt_center">NA</td>
</tr>
<tr>
<td headers="field_name" class="gt_row gt_left">hp</td>
<td headers="form_name" class="gt_row gt_left">basis</td>
<td headers="section_header" class="gt_row gt_center">NA</td>
<td headers="field_type" class="gt_row gt_left">text</td>
<td headers="field_label" class="gt_row gt_left">hp</td>
<td headers="select_choices_or_calculations" class="gt_row gt_center">NA</td>
<td headers="field_note" class="gt_row gt_center">NA</td>
<td headers="text_validation_type_or_show_slider_number" class="gt_row gt_center">NA</td>
<td headers="text_validation_min" class="gt_row gt_center">NA</td>
<td headers="text_validation_max" class="gt_row gt_center">NA</td>
<td headers="identifier" class="gt_row gt_center">NA</td>
<td headers="branching_logic" class="gt_row gt_center">NA</td>
<td headers="required_field" class="gt_row gt_center">NA</td>
<td headers="custom_alignment" class="gt_row gt_center">NA</td>
<td headers="question_number" class="gt_row gt_center">NA</td>
<td headers="matrix_group_name" class="gt_row gt_center">NA</td>
<td headers="matrix_ranking" class="gt_row gt_center">NA</td>
<td headers="field_annotation" class="gt_row gt_center">NA</td>
</tr>
<tr>
<td headers="field_name" class="gt_row gt_left">drat</td>
<td headers="form_name" class="gt_row gt_left">basis</td>
<td headers="section_header" class="gt_row gt_center">NA</td>
<td headers="field_type" class="gt_row gt_left">text</td>
<td headers="field_label" class="gt_row gt_left">drat</td>
<td headers="select_choices_or_calculations" class="gt_row gt_center">NA</td>
<td headers="field_note" class="gt_row gt_center">NA</td>
<td headers="text_validation_type_or_show_slider_number" class="gt_row gt_center">NA</td>
<td headers="text_validation_min" class="gt_row gt_center">NA</td>
<td headers="text_validation_max" class="gt_row gt_center">NA</td>
<td headers="identifier" class="gt_row gt_center">NA</td>
<td headers="branching_logic" class="gt_row gt_center">NA</td>
<td headers="required_field" class="gt_row gt_center">NA</td>
<td headers="custom_alignment" class="gt_row gt_center">NA</td>
<td headers="question_number" class="gt_row gt_center">NA</td>
<td headers="matrix_group_name" class="gt_row gt_center">NA</td>
<td headers="matrix_ranking" class="gt_row gt_center">NA</td>
<td headers="field_annotation" class="gt_row gt_center">NA</td>
</tr>
<tr>
<td headers="field_name" class="gt_row gt_left">wt</td>
<td headers="form_name" class="gt_row gt_left">basis</td>
<td headers="section_header" class="gt_row gt_center">NA</td>
<td headers="field_type" class="gt_row gt_left">text</td>
<td headers="field_label" class="gt_row gt_left">wt</td>
<td headers="select_choices_or_calculations" class="gt_row gt_center">NA</td>
<td headers="field_note" class="gt_row gt_center">NA</td>
<td headers="text_validation_type_or_show_slider_number" class="gt_row gt_center">NA</td>
<td headers="text_validation_min" class="gt_row gt_center">NA</td>
<td headers="text_validation_max" class="gt_row gt_center">NA</td>
<td headers="identifier" class="gt_row gt_center">NA</td>
<td headers="branching_logic" class="gt_row gt_center">NA</td>
<td headers="required_field" class="gt_row gt_center">NA</td>
<td headers="custom_alignment" class="gt_row gt_center">NA</td>
<td headers="question_number" class="gt_row gt_center">NA</td>
<td headers="matrix_group_name" class="gt_row gt_center">NA</td>
<td headers="matrix_ranking" class="gt_row gt_center">NA</td>
<td headers="field_annotation" class="gt_row gt_center">NA</td>
</tr>
<tr>
<td headers="field_name" class="gt_row gt_left">qsec</td>
<td headers="form_name" class="gt_row gt_left">basis</td>
<td headers="section_header" class="gt_row gt_center">NA</td>
<td headers="field_type" class="gt_row gt_left">text</td>
<td headers="field_label" class="gt_row gt_left">qsec</td>
<td headers="select_choices_or_calculations" class="gt_row gt_center">NA</td>
<td headers="field_note" class="gt_row gt_center">NA</td>
<td headers="text_validation_type_or_show_slider_number" class="gt_row gt_center">NA</td>
<td headers="text_validation_min" class="gt_row gt_center">NA</td>
<td headers="text_validation_max" class="gt_row gt_center">NA</td>
<td headers="identifier" class="gt_row gt_center">NA</td>
<td headers="branching_logic" class="gt_row gt_center">NA</td>
<td headers="required_field" class="gt_row gt_center">NA</td>
<td headers="custom_alignment" class="gt_row gt_center">NA</td>
<td headers="question_number" class="gt_row gt_center">NA</td>
<td headers="matrix_group_name" class="gt_row gt_center">NA</td>
<td headers="matrix_ranking" class="gt_row gt_center">NA</td>
<td headers="field_annotation" class="gt_row gt_center">NA</td>
</tr>
<tr>
<td headers="field_name" class="gt_row gt_left">vs</td>
<td headers="form_name" class="gt_row gt_left">basis</td>
<td headers="section_header" class="gt_row gt_center">NA</td>
<td headers="field_type" class="gt_row gt_left">text</td>
<td headers="field_label" class="gt_row gt_left">vs</td>
<td headers="select_choices_or_calculations" class="gt_row gt_center">NA</td>
<td headers="field_note" class="gt_row gt_center">NA</td>
<td headers="text_validation_type_or_show_slider_number" class="gt_row gt_center">NA</td>
<td headers="text_validation_min" class="gt_row gt_center">NA</td>
<td headers="text_validation_max" class="gt_row gt_center">NA</td>
<td headers="identifier" class="gt_row gt_center">NA</td>
<td headers="branching_logic" class="gt_row gt_center">NA</td>
<td headers="required_field" class="gt_row gt_center">NA</td>
<td headers="custom_alignment" class="gt_row gt_center">NA</td>
<td headers="question_number" class="gt_row gt_center">NA</td>
<td headers="matrix_group_name" class="gt_row gt_center">NA</td>
<td headers="matrix_ranking" class="gt_row gt_center">NA</td>
<td headers="field_annotation" class="gt_row gt_center">NA</td>
</tr>
<tr>
<td headers="field_name" class="gt_row gt_left">am</td>
<td headers="form_name" class="gt_row gt_left">basis</td>
<td headers="section_header" class="gt_row gt_center">NA</td>
<td headers="field_type" class="gt_row gt_left">text</td>
<td headers="field_label" class="gt_row gt_left">am</td>
<td headers="select_choices_or_calculations" class="gt_row gt_center">NA</td>
<td headers="field_note" class="gt_row gt_center">NA</td>
<td headers="text_validation_type_or_show_slider_number" class="gt_row gt_center">NA</td>
<td headers="text_validation_min" class="gt_row gt_center">NA</td>
<td headers="text_validation_max" class="gt_row gt_center">NA</td>
<td headers="identifier" class="gt_row gt_center">NA</td>
<td headers="branching_logic" class="gt_row gt_center">NA</td>
<td headers="required_field" class="gt_row gt_center">NA</td>
<td headers="custom_alignment" class="gt_row gt_center">NA</td>
<td headers="question_number" class="gt_row gt_center">NA</td>
<td headers="matrix_group_name" class="gt_row gt_center">NA</td>
<td headers="matrix_ranking" class="gt_row gt_center">NA</td>
<td headers="field_annotation" class="gt_row gt_center">NA</td>
</tr>
<tr>
<td headers="field_name" class="gt_row gt_left">gear</td>
<td headers="form_name" class="gt_row gt_left">basis</td>
<td headers="section_header" class="gt_row gt_center">NA</td>
<td headers="field_type" class="gt_row gt_left">text</td>
<td headers="field_label" class="gt_row gt_left">gear</td>
<td headers="select_choices_or_calculations" class="gt_row gt_center">NA</td>
<td headers="field_note" class="gt_row gt_center">NA</td>
<td headers="text_validation_type_or_show_slider_number" class="gt_row gt_center">NA</td>
<td headers="text_validation_min" class="gt_row gt_center">NA</td>
<td headers="text_validation_max" class="gt_row gt_center">NA</td>
<td headers="identifier" class="gt_row gt_center">NA</td>
<td headers="branching_logic" class="gt_row gt_center">NA</td>
<td headers="required_field" class="gt_row gt_center">NA</td>
<td headers="custom_alignment" class="gt_row gt_center">NA</td>
<td headers="question_number" class="gt_row gt_center">NA</td>
<td headers="matrix_group_name" class="gt_row gt_center">NA</td>
<td headers="matrix_ranking" class="gt_row gt_center">NA</td>
<td headers="field_annotation" class="gt_row gt_center">NA</td>
</tr>
<tr>
<td headers="field_name" class="gt_row gt_left">carb</td>
<td headers="form_name" class="gt_row gt_left">basis</td>
<td headers="section_header" class="gt_row gt_center">NA</td>
<td headers="field_type" class="gt_row gt_left">text</td>
<td headers="field_label" class="gt_row gt_left">carb</td>
<td headers="select_choices_or_calculations" class="gt_row gt_center">NA</td>
<td headers="field_note" class="gt_row gt_center">NA</td>
<td headers="text_validation_type_or_show_slider_number" class="gt_row gt_center">NA</td>
<td headers="text_validation_min" class="gt_row gt_center">NA</td>
<td headers="text_validation_max" class="gt_row gt_center">NA</td>
<td headers="identifier" class="gt_row gt_center">NA</td>
<td headers="branching_logic" class="gt_row gt_center">NA</td>
<td headers="required_field" class="gt_row gt_center">NA</td>
<td headers="custom_alignment" class="gt_row gt_center">NA</td>
<td headers="question_number" class="gt_row gt_center">NA</td>
<td headers="matrix_group_name" class="gt_row gt_center">NA</td>
<td headers="matrix_ranking" class="gt_row gt_center">NA</td>
<td headers="field_annotation" class="gt_row gt_center">NA</td>
</tr>
</tbody>
</table>
</div>
<p>The more advanced <code><a href="../reference/ds2dd_detailed.html">ds2dd_detailed()</a></code> is a natural
development. It will try to apply the most common data classes for data
validation and will assume that the first column is the id number. It
outputs a list with the dataset with modified variable names to comply
with REDCap naming conventions and a data dictionary.</p>
<p>The dataset should be correctly formatted for the data dictionary to
preserve as much information as possible.</p>
<div class="sourceCode" id="cb3"><pre class="downlit sourceCode r">
<code class="sourceCode R"><span><span class="va">d2</span> <span class="op">&lt;-</span> <span class="fu">REDCapCAST</span><span class="fu">::</span><span class="va"><a href="../reference/redcapcast_data.html">redcapcast_data</a></span> <span class="op">|&gt;</span> </span>
<span> <span class="fu">dplyr</span><span class="fu">::</span><span class="fu"><a href="https://dplyr.tidyverse.org/reference/mutate.html" class="external-link">mutate</a></span><span class="op">(</span>record_id <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/seq.html" class="external-link">seq_len</a></span><span class="op">(</span><span class="fu">dplyr</span><span class="fu">::</span><span class="fu"><a href="https://dplyr.tidyverse.org/reference/context.html" class="external-link">n</a></span><span class="op">(</span><span class="op">)</span><span class="op">)</span>,</span>
<span> region<span class="op">=</span><span class="fu"><a href="https://rdrr.io/r/base/factor.html" class="external-link">factor</a></span><span class="op">(</span><span class="va">region</span><span class="op">)</span><span class="op">)</span> <span class="op">|&gt;</span></span>
<span> <span class="fu">dplyr</span><span class="fu">::</span><span class="fu"><a href="https://dplyr.tidyverse.org/reference/select.html" class="external-link">select</a></span><span class="op">(</span><span class="va">record_id</span>, <span class="fu">dplyr</span><span class="fu">::</span><span class="fu"><a href="https://tidyselect.r-lib.org/reference/everything.html" class="external-link">everything</a></span><span class="op">(</span><span class="op">)</span><span class="op">)</span> <span class="op">|&gt;</span></span>
<span> <span class="op">(</span>\<span class="op">(</span><span class="va">.x</span><span class="op">)</span><span class="op">{</span></span>
<span> <span class="va">.x</span><span class="op">[</span><span class="op">!</span><span class="fu"><a href="https://rdrr.io/r/base/grep.html" class="external-link">grepl</a></span><span class="op">(</span><span class="st">"_complete$"</span>,<span class="fu"><a href="https://rdrr.io/r/base/names.html" class="external-link">names</a></span><span class="op">(</span><span class="va">.x</span><span class="op">)</span><span class="op">)</span><span class="op">]</span></span>
<span> <span class="op">}</span><span class="op">)</span><span class="op">(</span><span class="op">)</span> <span class="op">|&gt;</span> </span>
<span> <span class="op">(</span>\<span class="op">(</span><span class="va">.x</span><span class="op">)</span><span class="op">{</span></span>
<span> <span class="va">.x</span><span class="op">[</span><span class="op">!</span><span class="fu"><a href="https://rdrr.io/r/base/grep.html" class="external-link">grepl</a></span><span class="op">(</span><span class="st">"^redcap"</span>,<span class="fu"><a href="https://rdrr.io/r/base/names.html" class="external-link">names</a></span><span class="op">(</span><span class="va">.x</span><span class="op">)</span><span class="op">)</span><span class="op">]</span></span>
<span> <span class="op">}</span><span class="op">)</span><span class="op">(</span><span class="op">)</span> <span class="op">|&gt;</span> </span>
<span> <span class="fu"><a href="../reference/ds2dd_detailed.html">ds2dd_detailed</a></span><span class="op">(</span><span class="op">)</span> <span class="op">|&gt;</span> </span>
<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>
<span><span class="va">d2</span> <span class="op">|&gt;</span> </span>
<span> <span class="fu">gt</span><span class="fu">::</span><span class="fu"><a href="https://gt.rstudio.com/reference/gt.html" class="external-link">gt</a></span><span class="op">(</span><span class="op">)</span></span></code></pre></div>
<p>Additional specifications to the DataDictionary can be made manually,
or it can be uploaded and modified manually in the graphical user
interface on the REDCap server.</p>
</div>
<div class="section level3">
<h3 id="data-base-from-table">Data base from table<a class="anchor" aria-label="anchor" href="#data-base-from-table"></a>
</h3>
<p>…instructions and examples are coming…</p>
</div>
<div class="section level3">
<h3 id="meta-data-and-data-upload">Meta data and data upload<a class="anchor" aria-label="anchor" href="#meta-data-and-data-upload"></a>
</h3>
<p>Now the DataDictionary can be exported as a spreadsheet and uploaded
or it can be uploaded using the <code>REDCapR</code> package (only
projects with “Development” status).</p>
<p>Use one of the two approaches below:</p>
<div class="section level4">
<h4 id="manual-upload">Manual upload<a class="anchor" aria-label="anchor" href="#manual-upload"></a>
</h4>
<div class="sourceCode" id="cb4"><pre class="downlit sourceCode r">
<code class="sourceCode R"><span><span class="fu"><a href="https://rdrr.io/r/utils/write.table.html" class="external-link">write.csv</a></span><span class="op">(</span><span class="va">dd_ls</span><span class="op">$</span><span class="va">meta</span>, <span class="st">"datadictionary.csv"</span><span class="op">)</span></span></code></pre></div>
</div>
<div class="section level4">
<h4 id="upload-with-redcapr">Upload with <code>REDCapR</code><a class="anchor" aria-label="anchor" href="#upload-with-redcapr"></a>
</h4>
<div class="sourceCode" id="cb5"><pre class="downlit sourceCode r">
<code class="sourceCode R"><span><span class="fu">REDCapR</span><span class="fu">::</span><span class="fu"><a href="https://ouhscbbmc.github.io/REDCapR/reference/redcap_metadata_write.html" class="external-link">redcap_metadata_write</a></span><span class="op">(</span></span>
<span> <span class="va">dd_ls</span><span class="op">$</span><span class="va">meta</span>,</span>
<span> redcap_uri <span class="op">=</span> <span class="fu">keyring</span><span class="fu">::</span><span class="fu"><a href="https://keyring.r-lib.org/reference/key_get.html" class="external-link">key_get</a></span><span class="op">(</span><span class="st">"DB_URI"</span><span class="op">)</span>,</span>
<span> token <span class="op">=</span> <span class="fu">keyring</span><span class="fu">::</span><span class="fu"><a href="https://keyring.r-lib.org/reference/key_get.html" class="external-link">key_get</a></span><span class="op">(</span><span class="st">"DB_TOKEN"</span><span class="op">)</span></span>
<span><span class="op">)</span></span></code></pre></div>
<p>In the <a href="https://agdamsbo.github.io/redcap-r-handbook/" class="external-link">“REDCap R
Handbook”</a> more is written on interfacing with REDCap in R using the
<code><a href="https://keyring.r-lib.org/" class="external-link">library(keyring)</a></code>to store credentials in <a href="https://agdamsbo.github.io/redcap-r-handbook/doc/access.html#sec-getting-access" class="external-link">chapter
1.1</a>.</p>
</div>
</div>
<div class="section level3">
<h3 id="step-4---data-upload">Step 4 - Data upload<a class="anchor" aria-label="anchor" href="#step-4---data-upload"></a>
</h3>
<p>The same two options are available for data upload as meta data
upload: manual or through <code>REDCapR</code>.</p>
<p>Only the latter is shown here.</p>
<div class="sourceCode" id="cb6"><pre class="downlit sourceCode r">
<code class="sourceCode R"><span><span class="fu">REDCapR</span><span class="fu">::</span><span class="fu"><a href="https://ouhscbbmc.github.io/REDCapR/reference/redcap_write.html" class="external-link">redcap_write</a></span><span class="op">(</span></span>
<span> <span class="va">dd_ls</span><span class="op">$</span><span class="va">data</span>,</span>
<span> redcap_uri <span class="op">=</span> <span class="fu">keyring</span><span class="fu">::</span><span class="fu"><a href="https://keyring.r-lib.org/reference/key_get.html" class="external-link">key_get</a></span><span class="op">(</span><span class="st">"DB_URI"</span><span class="op">)</span>,</span>
<span> token <span class="op">=</span> <span class="fu">keyring</span><span class="fu">::</span><span class="fu"><a href="https://keyring.r-lib.org/reference/key_get.html" class="external-link">key_get</a></span><span class="op">(</span><span class="st">"DB_TOKEN"</span><span class="op">)</span></span>
<span><span class="op">)</span></span></code></pre></div>
</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>
Reference in New Issue View Git Blame Copy Permalink