mirror of
https://github.com/agdamsbo/REDCapCAST.git
synced 2024-12-05 02:21:54 +01:00
478 lines
16 KiB
HTML
478 lines
16 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>Package index • 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="Package index"><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-index">
|
|
<div class="row">
|
|
<main id="main" class="col-md-9"><div class="page-header">
|
|
<img src="../logo.png" class="logo" alt=""><h1>Package index</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 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="all_na.html">all_na()</a></code>
|
|
|
|
</dt>
|
|
<dd>Check if vector is all NA</dd>
|
|
</dl><dl><dt>
|
|
|
|
<code><a href="apply_factor_labels.html">apply_factor_labels()</a></code>
|
|
|
|
</dt>
|
|
<dd>Preserve all factor levels from REDCap data dictionary in data export</dd>
|
|
</dl><dl><dt>
|
|
|
|
<code><a href="apply_field_label.html">apply_field_label()</a></code>
|
|
|
|
</dt>
|
|
<dd>Apply REDCap filed labels to data frame</dd>
|
|
</dl><dl><dt>
|
|
|
|
<code><a href="as_factor.html">as_factor()</a></code>
|
|
|
|
</dt>
|
|
<dd>Convert labelled vectors to factors while preserving attributes</dd>
|
|
</dl><dl><dt>
|
|
|
|
<code><a href="case_match_regex_list.html">case_match_regex_list()</a></code>
|
|
|
|
</dt>
|
|
<dd>List-base regex case_when</dd>
|
|
</dl><dl><dt>
|
|
|
|
<code><a href="cast_data_overview.html">cast_data_overview()</a></code>
|
|
|
|
</dt>
|
|
<dd>Overview of REDCapCAST data for shiny</dd>
|
|
</dl><dl><dt>
|
|
|
|
<code><a href="cast_meta_overview.html">cast_meta_overview()</a></code>
|
|
|
|
</dt>
|
|
<dd>Overview of REDCapCAST meta data for shiny</dd>
|
|
</dl><dl><dt>
|
|
|
|
<code><a href="char2choice.html">char2choice()</a></code>
|
|
|
|
</dt>
|
|
<dd>Simple function to generate REDCap choices from character vector</dd>
|
|
</dl><dl><dt>
|
|
|
|
<code><a href="char2cond.html">char2cond()</a></code>
|
|
|
|
</dt>
|
|
<dd>Simple function to generate REDCap branching logic from character vector</dd>
|
|
</dl><dl><dt>
|
|
|
|
<code><a href="clean_field_label.html">clean_field_label()</a></code>
|
|
|
|
</dt>
|
|
<dd>Very simple function to remove rich text formatting from field label and save the first paragraph ('<p>...</p>').</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="compact_vec.html">compact_vec()</a></code>
|
|
|
|
</dt>
|
|
<dd>Compacting a vector of any length with or without names</dd>
|
|
</dl><dl><dt>
|
|
|
|
<code><a href="create_html_table.html">create_html_table()</a></code>
|
|
|
|
</dt>
|
|
<dd>Create two-column HTML table for data piping in REDCap instruments</dd>
|
|
</dl><dl><dt>
|
|
|
|
<code><a href="create_instrument_meta.html">create_instrument_meta()</a></code>
|
|
|
|
</dt>
|
|
<dd>DEPRICATED Create zips file with necessary content based on data set</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="doc2dd.html">doc2dd()</a></code>
|
|
|
|
</dt>
|
|
<dd>Doc table to data dictionary - EARLY, DOCS MISSING</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="export_redcap_instrument.html">export_redcap_instrument()</a></code>
|
|
|
|
</dt>
|
|
<dd>Creates zip-file with necessary content to manually add instrument to database</dd>
|
|
</dl><dl><dt>
|
|
|
|
<code><a href="fct2num.html">fct2num()</a></code>
|
|
|
|
</dt>
|
|
<dd>Allows conversion of factor to numeric values preserving original levels</dd>
|
|
</dl><dl><dt>
|
|
|
|
<code><a href="fct_drop.html">fct_drop.data.frame()</a></code>
|
|
|
|
</dt>
|
|
<dd>Drop unused levels preserving label data</dd>
|
|
</dl><dl><dt>
|
|
|
|
<code><a href="file_extension.html">file_extension()</a></code>
|
|
|
|
</dt>
|
|
<dd>DEPRECATED 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="format_redcap_factor.html">format_redcap_factor()</a></code>
|
|
|
|
</dt>
|
|
<dd>Converts REDCap choices to factor levels and stores in labels attribute</dd>
|
|
</dl><dl><dt>
|
|
|
|
<code><a href="format_subheader.html">format_subheader()</a></code>
|
|
|
|
</dt>
|
|
<dd>Sub-header formatting wrapper</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_attr.html">get_attr()</a></code>
|
|
|
|
</dt>
|
|
<dd>Extract attribute. Returns NA if none</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.html">guess_time_only()</a></code>
|
|
|
|
</dt>
|
|
<dd>Guess time variables based on naming pattern</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="haven_all_levels.html">haven_all_levels()</a></code>
|
|
|
|
</dt>
|
|
<dd>Finish incomplete haven attributes substituting missings with values</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="html_tag_wrap.html">html_tag_wrap()</a></code>
|
|
|
|
</dt>
|
|
<dd>Simple html tag wrapping for REDCap text formatting</dd>
|
|
</dl><dl><dt>
|
|
|
|
<code><a href="is.labelled.html">is.labelled()</a></code>
|
|
|
|
</dt>
|
|
<dd>Tests for multiple label classes</dd>
|
|
</dl><dl><dt>
|
|
|
|
<code><a href="is_missing.html">is_missing()</a></code>
|
|
|
|
</dt>
|
|
<dd>Multi missing check</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="named_levels.html">named_levels()</a></code>
|
|
|
|
</dt>
|
|
<dd>Get named vector of factor levels and values</dd>
|
|
</dl><dl><dt>
|
|
|
|
<code><a href="nav_bar_page.html">nav_bar_page()</a></code>
|
|
|
|
</dt>
|
|
<dd>Nav_bar defining function for shiny ui</dd>
|
|
</dl><dl><dt>
|
|
|
|
<code><a href="numchar2fct.html">numchar2fct()</a></code>
|
|
|
|
</dt>
|
|
<dd>Applying var2fct across data set</dd>
|
|
</dl><dl><dt>
|
|
|
|
<code><a href="parse_data.html">parse_data()</a></code>
|
|
|
|
</dt>
|
|
<dd>Helper to auto-parse un-formatted data with haven and readr</dd>
|
|
</dl><dl><dt>
|
|
|
|
<code><a href="possibly_numeric.html">possibly_numeric()</a></code>
|
|
|
|
</dt>
|
|
<dd>Tests if vector can be interpreted as numeric without introducing NAs by coercion</dd>
|
|
</dl><dl><dt>
|
|
|
|
<code><a href="possibly_roman.html">possibly_roman()</a></code>
|
|
|
|
</dt>
|
|
<dd>Test if vector can be interpreted as roman numerals</dd>
|
|
</dl><dl><dt>
|
|
|
|
<code><a href="process_user_input.html">process_user_input()</a></code>
|
|
|
|
</dt>
|
|
<dd>User input processing</dd>
|
|
</dl><dl><dt>
|
|
|
|
<code><a href="process_user_input.character.html">process_user_input(<i><character></i>)</a></code>
|
|
|
|
</dt>
|
|
<dd>User input processing character</dd>
|
|
</dl><dl><dt>
|
|
|
|
<code><a href="process_user_input.data.frame.html">process_user_input(<i><data.frame></i>)</a></code>
|
|
|
|
</dt>
|
|
<dd>User input processing data.frame</dd>
|
|
</dl><dl><dt>
|
|
|
|
<code><a href="process_user_input.default.html">process_user_input(<i><default></i>)</a></code>
|
|
|
|
</dt>
|
|
<dd>User input processing default</dd>
|
|
</dl><dl><dt>
|
|
|
|
<code><a href="process_user_input.response.html">process_user_input(<i><response></i>)</a></code>
|
|
|
|
</dt>
|
|
<dd>User input processing response</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>Transforms list of REDCap data.frames to a single wide data.frame</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="replace_curly_quote.html">replace_curly_quote()</a></code>
|
|
|
|
</dt>
|
|
<dd>Replace curly apostrophes and quotes from word</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="set_attr.html">set_attr()</a></code>
|
|
|
|
</dt>
|
|
<dd>Set attributes for named attribute. Appends if attr is NULL</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="suffix2label.html">suffix2label()</a></code>
|
|
|
|
</dt>
|
|
<dd>Transfer variable name suffix to label in widened data</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="var2fct.html">var2fct()</a></code>
|
|
|
|
</dt>
|
|
<dd>Convert vector to factor based on threshold of number of unique levels</dd>
|
|
</dl><dl><dt>
|
|
|
|
<code><a href="vec2choice.html">vec2choice()</a></code>
|
|
|
|
</dt>
|
|
<dd>Named vector to REDCap choices (`wrapping compact_vec()`)</dd>
|
|
</dl></div>
|
|
</main></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>
|
|
|