FreesearchR/reference/index.html

439 lines
15 KiB
HTML
Raw Normal View 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>Package index • freesearcheR</title><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/Montserrat-0.4.9/font.css" rel="stylesheet"><link href="../deps/Public_Sans-0.4.9/font.css" rel="stylesheet"><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><link href="../extra.css" rel="stylesheet"><meta property="og:title" content="Package index"></head><body>
<a href="#main" class="visually-hidden-focusable">Skip to contents</a>
<nav class="navbar navbar-expand-lg fixed-top bg-primary" data-bs-theme="dark" aria-label="Site navigation"><div class="container">
<a class="navbar-brand me-2" href="../index.html">freesearcheR</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">25.2.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="active nav-item"><a class="nav-link" href="../reference/index.html">Reference</a></li>
<li class="nav-item"><a class="nav-link" href="../ROADMAP.html">Roadmap</a></li>
<li class="nav-item"><a class="nav-link" href="../QA.html">Q&amp;A</a></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/freesearcheR/" 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">
<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="add_class_icon.html">add_class_icon()</a></code>
</dt>
<dd>Convert class grid column to icon</dd>
</dl><dl><dt>
<code><a href="add_sparkline.html">add_sparkline()</a></code>
</dt>
<dd>Add sparkline to datagrid</dd>
</dl><dl><dt>
<code><a href="all_but.html">all_but()</a></code>
</dt>
<dd>Select all from vector but</dd>
</dl><dl><dt>
<code><a href="append_list.html">append_list()</a></code>
</dt>
<dd>Append list with named index</dd>
</dl><dl><dt>
<code><a href="argsstring2list.html">argsstring2list()</a></code>
</dt>
<dd>Convert string of arguments to list of arguments</dd>
</dl><dl><dt>
<code><a href="baseline_table.html">baseline_table()</a></code>
</dt>
<dd>Print a flexible baseline characteristics table</dd>
</dl><dl><dt>
<code><a href="clean_date.html">clean_date()</a></code>
</dt>
<dd>Attempts at applying uniform date format</dd>
</dl><dl><dt>
<code><a href="clean_sep.html">clean_sep()</a></code>
</dt>
<dd>gsub wrapper for piping with default values for separator substituting</dd>
</dl><dl><dt>
<code><a href="contrast_text.html">contrast_text()</a></code>
</dt>
<dd>Contrast Text Color</dd>
</dl><dl><dt>
<code><a href="create_overview_datagrid.html">create_overview_datagrid()</a></code>
</dt>
<dd>Create a data overview datagrid</dd>
</dl><dl><dt>
<code><a href="custom_theme.html">custom_theme()</a></code>
</dt>
<dd>Custom theme based on unity</dd>
</dl><dl><dt>
<code><a href="cut-variable.html">cut_variable_ui()</a></code> <code><a href="cut-variable.html">cut_variable_server()</a></code> <code><a href="cut-variable.html">modal_cut_variable()</a></code> <code><a href="cut-variable.html">winbox_cut_variable()</a></code>
</dt>
<dd>Module to Convert Numeric to Factor</dd>
</dl><dl><dt>
<code><a href="cut.html">cut(<i>&lt;hms&gt;</i>)</a></code> <code><a href="cut.html">cut(<i>&lt;POSIXt&gt;</i>)</a></code> <code><a href="cut.html">cut(<i>&lt;POSIXct&gt;</i>)</a></code> <code><a href="cut.html">cut(<i>&lt;Date&gt;</i>)</a></code>
</dt>
<dd>Extended cutting function</dd>
</dl><dl><dt>
<code><a href="data-correlations.html">data_correlations_ui()</a></code> <code><a href="data-correlations.html">data_correlations_server()</a></code> <code><a href="data-correlations.html">data_visuals_ui()</a></code> <code><a href="data-correlations.html">data_visuals_server()</a></code>
</dt>
<dd>Data correlations evaluation module</dd>
</dl><dl><dt>
<code><a href="data-plots.html">plot_ridge()</a></code> <code><a href="data-plots.html">create_plot()</a></code> <code><a href="data-plots.html">plot_hbars()</a></code> <code><a href="data-plots.html">plot_violin()</a></code> <code><a href="data-plots.html">plot_scatter()</a></code> <code><a href="data-plots.html">plot_sankey()</a></code>
</dt>
<dd>Title</dd>
</dl><dl><dt>
<code><a href="data-summary.html">data_summary_ui()</a></code> <code><a href="data-summary.html">data_summary_server()</a></code>
</dt>
<dd>Data summary module</dd>
</dl><dl><dt>
<code><a href="default_format_arguments.html">default_format_arguments()</a></code>
</dt>
<dd>Defaults qmd formats</dd>
</dl><dl><dt>
<code><a href="default_parsing.html">default_parsing()</a></code>
</dt>
<dd>Default data parsing</dd>
</dl><dl><dt>
<code><a href="factorize.html">factorize()</a></code>
</dt>
<dd>Factorize variables in data.frame</dd>
</dl><dl><dt>
<code><a href="file_export.html">file_export()</a></code>
</dt>
<dd>Title</dd>
</dl><dl><dt>
<code><a href="format_writer.html">format_writer()</a></code>
</dt>
<dd>Merges list of named arguments for qmd header generation</dd>
</dl><dl><dt>
<code><a href="get_fun_options.html">get_fun_options()</a></code>
</dt>
<dd>Get the function options based on the selected function description</dd>
</dl><dl><dt>
<code><a href="get_label.html">get_label()</a></code>
</dt>
<dd>Print label, and if missing print variable name</dd>
</dl><dl><dt>
<code><a href="get_plot_options.html">get_plot_options()</a></code>
</dt>
<dd>Get the function options based on the selected function description</dd>
</dl><dl><dt>
<code><a href="getfun.html">getfun()</a></code>
</dt>
<dd>Wrapper function to get function from character vector referring to function from namespace. Passed to 'do.call()'</dd>
</dl><dl><dt>
<code><a href="gg_theme_export.html">gg_theme_export()</a></code>
</dt>
<dd>GGplot default theme for plotting export objects</dd>
</dl><dl><dt>
<code><a href="gg_theme_shiny.html">gg_theme_shiny()</a></code>
</dt>
<dd>GGplot default theme for plotting in Shiny</dd>
</dl><dl><dt>
<code><a href="index_embed.html">index_embed()</a></code>
</dt>
<dd>Split vector by an index and embed addition</dd>
</dl><dl><dt>
<code><a href="is_any_class.html">is_any_class()</a></code>
</dt>
<dd>Test class</dd>
</dl><dl><dt>
<code><a href="is_consecutive.html">is_consecutive()</a></code>
</dt>
<dd>Checks if elements in vector are equally spaced as indication of ID</dd>
</dl><dl><dt>
<code><a href="is_datetime.html">is_datetime()</a></code>
</dt>
<dd>Test is date/datetime/time</dd>
</dl><dl><dt>
<code><a href="is_valid_redcap_url.html">is_valid_redcap_url()</a></code>
</dt>
<dd>Title</dd>
</dl><dl><dt>
<code><a href="is_valid_token.html">is_valid_token()</a></code>
</dt>
<dd>Validate REDCap token</dd>
</dl><dl><dt>
<code><a href="launch_freesearcheR.html">launch_freesearcheR()</a></code>
</dt>
<dd>Easily launch the freesearcheR app</dd>
</dl><dl><dt>
<code><a href="line_break.html">line_break()</a></code>
</dt>
<dd>Line breaking at given number of characters for nicely plotting labels</dd>
</dl><dl><dt>
<code><a href="m_datafileUI.html">m_datafileUI()</a></code>
</dt>
<dd>Shiny UI module to load a data file</dd>
</dl><dl><dt>
<code><a href="merge_long.html">merge_long()</a></code>
</dt>
<dd>Wrapper to pivot gtsummary table data to long for plotting</dd>
</dl><dl><dt>
<code><a href="modify_qmd.html">modify_qmd()</a></code>
</dt>
<dd>Wrapper to modify quarto file to render specific formats</dd>
</dl><dl><dt>
<code><a href="outcome_type.html">outcome_type()</a></code>
</dt>
<dd>Outcome data type assessment</dd>
</dl><dl><dt>
<code><a href="overview_vars.html">overview_vars()</a></code>
</dt>
<dd>Create a data overview data.frame ready for sparklines</dd>
</dl><dl><dt>
<code><a href="plot.tbl_regression.html">plot(<i>&lt;tbl_regression&gt;</i>)</a></code>
</dt>
<dd>Regression coef plot from gtsummary. Slightly modified to pass on arguments</dd>
</dl><dl><dt>
<code><a href="plot_sankey_single.html">plot_sankey_single()</a></code>
</dt>
<dd>Beautiful sankey plot</dd>
</dl><dl><dt>
<code><a href="possible_functions.html">possible_functions()</a></code>
</dt>
<dd>Get possible regression models</dd>
</dl><dl><dt>
<code><a href="possible_plots.html">possible_plots()</a></code>
</dt>
<dd>Get possible regression models</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="redcap_read_shiny_module.html">m_redcap_readUI()</a></code> <code><a href="redcap_read_shiny_module.html">m_redcap_readServer()</a></code> <code><a href="redcap_read_shiny_module.html">redcap_demo_app()</a></code>
</dt>
<dd>Shiny module to browser and export REDCap data</dd>
</dl><dl><dt>
<code><a href="regression_model.html">regression_model()</a></code> <code><a href="regression_model.html">regression_model_uv()</a></code> <code><a href="regression_model.html">regression_model_list()</a></code> <code><a href="regression_model.html">regression_model_uv_list()</a></code>
</dt>
<dd>Create a regression model programatically</dd>
</dl><dl><dt>
<code><a href="regression_table.html">regression_table()</a></code>
</dt>
<dd>Create table of regression model</dd>
</dl><dl><dt>
<code><a href="remove_empty_cols.html">remove_empty_cols()</a></code>
</dt>
<dd>Removes columns with completenes below cutoff</dd>
</dl><dl><dt>
<code><a href="remove_na_attr.html">remove_na_attr()</a></code>
</dt>
<dd>Remove NA labels</dd>
</dl><dl><dt>
<code><a href="sankey_ready.html">sankey_ready()</a></code>
</dt>
<dd>Readying data for sankey plot</dd>
</dl><dl><dt>
<code><a href="shiny_freesearcheR.html">shiny_freesearcheR()</a></code>
</dt>
<dd>Launch the freesearcheR tool locally</dd>
</dl><dl><dt>
<code><a href="specify_qmd_format.html">specify_qmd_format()</a></code>
</dt>
<dd>Specify format arguments to include in qmd header/frontmatter</dd>
</dl><dl><dt>
<code><a href="subset_types.html">subset_types()</a></code>
</dt>
<dd>Easily subset by data type function</dd>
</dl><dl><dt>
<code><a href="supported_functions.html">supported_functions()</a></code>
</dt>
<dd>Implemented functions</dd>
</dl><dl><dt>
<code><a href="supported_plots.html">supported_plots()</a></code>
</dt>
<dd>Implemented functions</dd>
</dl><dl><dt>
<code><a href="tbl_merge.html">tbl_merge()</a></code>
</dt>
<dd>A substitue to gtsummary::tbl_merge, that will use list names for the tab spanner names.</dd>
</dl><dl><dt>
<code><a href="update-factor.html">update_factor_ui()</a></code> <code><a href="update-factor.html">update_factor_server()</a></code> <code><a href="update-factor.html">modal_update_factor()</a></code>
</dt>
<dd>Module to Reorder the Levels of a Factor Variable</dd>
</dl><dl><dt>
<code><a href="update-variables.html">update_variables_ui()</a></code> <code><a href="update-variables.html">update_variables_server()</a></code>
</dt>
<dd>Select, rename and convert variables</dd>
</dl><dl><dt>
<code><a href="update_variables_datagrid.html">update_variables_datagrid()</a></code>
</dt>
<dd>Modified from the datamods pacakge</dd>
</dl><dl><dt>
<code><a href="vertical_stacked_bars.html">vertical_stacked_bars()</a></code>
</dt>
<dd>Vertical stacked bar plot wrapper</dd>
</dl><dl><dt>
<code><a href="write_quarto.html">write_quarto()</a></code>
</dt>
<dd>Wrapper to save data in RDS, load into specified qmd and render</dd>
</dl></div>
</main></div>
<footer><div class="pkgdown-footer-left">
<p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.1.1.</p>
</div>
<div class="pkgdown-footer-right">
<p>Developed by Andreas Gammelgaard Damsbo. Provided without <strong>any warranty</strong>.</p>
</div>
</footer></div>
</body></html>