Deploying to gh-pages from @ agdamsbo/FreesearchR@b1c44a75ef 🚀

This commit is contained in:
agdamsbo 2025-04-22 08:20:29 +00:00
commit 3a53dd4dfa
15 changed files with 355 additions and 101 deletions

View file

@ -138,6 +138,21 @@ data insights and code generation for basic plotting to fine tune.</p>
</div>
</div>
<div class="section level3">
<h3 id="data">Data<a class="anchor" aria-label="anchor" href="#data"></a>
</h3>
<p>This is the panel to get a good overview of your data, check data is
classed and formatted correctly, perform simple modifications and filter
data.</p>
<div class="section level4">
<h4 id="summary">Summary<a class="anchor" aria-label="anchor" href="#summary"></a>
</h4>
</div>
<div class="section level4">
<h4 id="modify">Modify<a class="anchor" aria-label="anchor" href="#modify"></a>
</h4>
</div>
</div>
<div class="section level3">
<h3 id="evaluate">Evaluate<a class="anchor" aria-label="anchor" href="#evaluate"></a>
</h3>
<p>This panel allows for basic data evaluation.</p>
@ -219,29 +234,6 @@ visualise data distribution</td>
set relationships</td>
</tr>
<tr class="odd">
<td align="left">ordinal</td>
<td align="left">Stacked horizontal bars</td>
<td align="left">A classical way of visualising the distribution of an
ordinal scale like the modified Ranking Scale and known as Grotta
bars</td>
</tr>
<tr class="even">
<td align="left">ordinal</td>
<td align="left">Violin plot</td>
<td align="left">A modern alternative to the classic boxplot to
visualise data distribution</td>
</tr>
<tr class="odd">
<td align="left">ordinal</td>
<td align="left">Sankey plot</td>
<td align="left">A way of visualising change between groups</td>
</tr>
<tr class="even">
<td align="left">ordinal</td>
<td align="left">Box plot</td>
<td align="left">A classic way to plot data distribution by groups</td>
</tr>
<tr class="odd">
<td align="left">categorical</td>
<td align="left">Stacked horizontal bars</td>
<td align="left">A classical way of visualising the distribution of an
@ -277,6 +269,41 @@ fine tune all the small details.</p>
<p>This section is only intended for very simple explorative analyses
and as a proof-of-concept for now. If you are doing complex regression
analyses you should probably just write the code yourself.</p>
<p>Below are the available regression types listed.</p>
<table class="table">
<colgroup>
<col width="16%">
<col width="46%">
<col width="15%">
<col width="21%">
</colgroup>
<thead><tr class="header">
<th align="left">Data type</th>
<th align="left">Regression model</th>
<th align="left">Function</th>
<th align="left">Study design</th>
</tr></thead>
<tbody>
<tr class="odd">
<td align="left">continuous</td>
<td align="left">Linear regression model</td>
<td align="left">stats::lm</td>
<td align="left">cross-sectional</td>
</tr>
<tr class="even">
<td align="left">dichotomous</td>
<td align="left">Logistic regression model</td>
<td align="left">stats::glm</td>
<td align="left">cross-sectional</td>
</tr>
<tr class="odd">
<td align="left">categorical</td>
<td align="left">Ordinal logistic regression model</td>
<td align="left">MASS::polr</td>
<td align="left">cross-sectional</td>
</tr>
</tbody>
</table>
<div class="section level4">
<h4 id="table">Table<a class="anchor" aria-label="anchor" href="#table"></a>
</h4>
@ -305,7 +332,7 @@ Choose which model(s) to include.</p>
model results. Choose between MS Word or LibreOffice format.</p>
</div>
<div class="section level4">
<h4 id="data">Data<a class="anchor" aria-label="anchor" href="#data"></a>
<h4 id="data-1">Data<a class="anchor" aria-label="anchor" href="#data-1"></a>
</h4>
<p>Export the modified dataset in different formats.</p>
</div>

163
articles/data-types.html Normal file
View file

@ -0,0 +1,163 @@
<!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>Data types • FreesearchR</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.10/font.css" rel="stylesheet">
<link href="../deps/Public_Sans-0.4.10/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="Data types">
</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">FreesearchR</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">25.4.3</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/FreesearchR.html">Get started</a></li>
<li class="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/FreesearchR/" 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">
<h1>Data types</h1>
<small class="dont-index">Source: <a href="https://github.com/agdamsbo/FreesearchR/blob/main/vignettes/data-types.Rmd" class="external-link"><code>vignettes/data-types.Rmd</code></a></small>
<div class="d-none name"><code>data-types.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/FreesearchR" class="external-link">FreesearchR</a></span><span class="op">)</span></span>
<span><span class="co">#&gt; </span></span>
<span><span class="co">#&gt; Attaching package: 'FreesearchR'</span></span>
<span><span class="co">#&gt; The following object is masked from 'package:base':</span></span>
<span><span class="co">#&gt; </span></span>
<span><span class="co">#&gt; sort_by</span></span></code></pre></div>
<div class="section level2">
<h2 id="a-clinical-data-class">A clinical data class<a class="anchor" aria-label="anchor" href="#a-clinical-data-class"></a>
</h2>
<p>Traditionally in <em>R</em>, data is identified by classes, like
numeric, integer, double, logical, factor etc. These classes can be a
little confusing from a clinical or operational standpoint. In the
<strong><em>FreesearchR</em></strong> app, these classes has been
simplified and modified to the following data types, that are assigned
on a prioritised order like the following:</p>
<table class="table">
<colgroup>
<col width="14%">
<col width="50%">
<col width="35%">
</colgroup>
<thead><tr class="header">
<th align="left">Data type</th>
<th align="left">Description</th>
<th align="left">Data classes included</th>
</tr></thead>
<tbody>
<tr class="odd">
<td align="left">empty</td>
<td align="left">Variable of all NAs</td>
<td align="left">Any class</td>
</tr>
<tr class="even">
<td align="left">monotone</td>
<td align="left">Variable with only one unique value</td>
<td align="left">Any class</td>
</tr>
<tr class="odd">
<td align="left">dichotomous</td>
<td align="left">Variable with only two unique values</td>
<td align="left">Any class</td>
</tr>
<tr class="even">
<td align="left">categorical</td>
<td align="left">Factor variable</td>
<td align="left">factor (ordered or unordered)</td>
</tr>
<tr class="odd">
<td align="left">text</td>
<td align="left">Character variable</td>
<td align="left">character</td>
</tr>
<tr class="even">
<td align="left">datetime</td>
<td align="left">Variable of time, date or datetime values</td>
<td align="left">hms, Date, POSIXct and POSIXt</td>
</tr>
<tr class="odd">
<td align="left">continuous</td>
<td align="left">Numeric variable</td>
<td align="left">numeric, integer or double</td>
</tr>
<tr class="even">
<td align="left">unknown</td>
<td align="left">Anything not falling within the previous</td>
<td align="left">Any other class</td>
</tr>
</tbody>
</table>
<p>Categorising data in this way makes sense when making choices on how
to evaluate and analyse data. This is used throughout the
<strong><em>FreesearchR</em></strong> app to simplify data handling.</p>
</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>

View file

@ -38,7 +38,9 @@
<h3>All vignettes</h3>
<div class="section-desc"></div>
<dl><dt><a href="FreesearchR.html">FreesearchR</a></dt>
<dl><dt><a href="data-types.html">Data types</a></dt>
<dd>
</dd><dt><a href="FreesearchR.html">FreesearchR</a></dt>
<dd>
</dd></dl></div>
</main></div>