andreas/FreesearchR
1
0
Fork 0
mirror of https://github.com/agdamsbo/FreesearchR.git synced 2026-06-19 12:37:30 +02:00
Code Issues Projects Releases Packages Wiki Activity

external docs linked and updated

Browse source
This commit is contained in:
Andreas Gammelgaard Damsbo 2025-01-16 12:23:39 +01:00
commit 83fac94266
No known key found for this signature in database
9 changed files with 103 additions and 154 deletions
Download patch file Download diff file Expand all files Collapse all files

69
inst/apps/data_analysis_modules/www/docs.html
View file

@ -1,69 +0,0 @@
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
<meta charset="utf-8">
<meta name="generator" content="quarto-1.5.57">
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
<title>freesearcheR platform documentation</title>
<style>
code{white-space: pre-wrap;}
span.smallcaps{font-variant: small-caps;}
div.columns{display: flex; gap: min(4vw, 1.5em);}
div.column{flex: auto; overflow-x: auto;}
div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;}
ul.task-list{list-style: none;}
ul.task-list li input[type="checkbox"] {
width: 0.8em;
margin: 0 0.8em 0.2em -1em; vertical-align: middle;
}
.display.math{display: block; text-align: center; margin: 0.5rem auto;}
</style>
</head>
<body>
<header id="title-block-header">
<h1 class="title"><strong><em>freesearcheR</em></strong> platform documentation</h1>
</header>
<h1 id="welcome">Welcome!</h1>
<p>So glad to see you here! Welcome to test this early concept of a platform to easily explore, manipulate and analyse clinical data.</p>
<p>Below will be a more detailed description of the included features and possibilities, as well as the planned and possible feature additions.</p>
<h2 id="contribute">Contribute</h2>
<p>Contributions are very welcome. If you find anything odd, or you think of features to add or remove, please <a href="https://github.com/agdamsbo/freesearcheR/issues">share and report on the project page on GitHub</a>.</p>
<h2 id="roadmap">Roadmap</h2>
<ul>
<li><p><label><input type="checkbox">Stratified analyses</label></p></li>
<li><p>Additional study designs:</p>
<ul class="task-list">
<li><p><label><input type="checkbox" checked>Cross-sectional data analyses</label></p></li>
<li><p><label><input type="checkbox">Longitudinal data analyses</label></p></li>
<li><p><label><input type="checkbox">Survival analysis</label></p></li>
</ul></li>
<li><p>More detailed variable browser</p>
<ul class="task-list">
<li><p><label><input type="checkbox">Add histograms for data distribution</label></p></li>
<li><p><label><input type="checkbox">Option to edit variable labels for nicer tables</label></p></li>
</ul></li>
<li><p><label><input type="checkbox">Plot regression analyses results</label></p></li>
<li><p><label><input type="checkbox" checked>Export modified data. 2025-01-09</label></p></li>
<li><p><label><input type="checkbox">Include reproducible code for all steps</label></p></li>
<li><p><label><input type="checkbox" checked><del>Modify factor levels</del> Factor level modification is possible through converting factors to numeric &gt; cutting numeric with desired fixed values. 2024-12-12</label></p></li>
<li><p><label><input type="checkbox" checked>More options for date/datetime/time grouping/factoring. Included weekday and month-only options. 2024-12-12</label></p></li>
</ul>
</body></html>

45
inst/apps/data_analysis_modules/www/docs.qmd
View file

@ -1,45 +0,0 @@
---
title: "***freesearcheR*** platform documentation"
format:
html:
self-contained: true
minimal: true
---
# Welcome!
So glad to see you here! Welcome to test this early concept of a platform to easily explore, manipulate and analyse clinical data.
Below will be a more detailed description of the included features and possibilities, as well as the planned and possible feature additions.
## Contribute
Contributions are very welcome. If you find anything odd, or you think of features to add or remove, please [share and report on the project page on GitHub](https://github.com/agdamsbo/freesearcheR/issues).
## Roadmap
- [ ] Stratified analyses
- Additional study designs:
- [x] Cross-sectional data analyses
- [ ] Longitudinal data analyses
- [ ] Survival analysis
- More detailed variable browser
- [ ] Add histograms for data distribution
- [ ] Option to edit variable labels for nicer tables
- [ ] Plot regression analyses results
- [x] Export modified data. 2025-01-09
- [ ] Include reproducible code for all steps
- [x] ~~Modify factor levels~~ Factor level modification is possible through converting factors to numeric > cutting numeric with desired fixed values. 2024-12-12
- [x] More options for date/datetime/time grouping/factoring. Included weekday and month-only options. 2024-12-12

22
inst/apps/data_analysis_modules/www/intro.html
View file

@ -354,18 +354,18 @@ display: none;
<div id="welcome" class="section level1">
<h1>Welcome</h1>
<p>This is the <strong><em>freesearchR</em></strong> web data analysis
tool. We intend the <strong><em>freesearchR</em></strong> to be a
<p>This is the <strong><em>freesearcheR</em></strong> web data analysis
tool. We intend the <strong><em>freesearcheR</em></strong> to be a
powerful and free tool for easy data evaluation and analysis at the
hands of the clinician.</p>
<p>By intention, this tool has been designed to be simple to use with a
minimum of mandatory options to keep the workflow streamlined, while
also including a few options to go even further.</p>
<p>There are four simple steps to go through:</p>
<p>There are four simple steps to go through (see corresponding tabs in
the top):</p>
<ol style="list-style-type: decimal">
<li><p><a onclick="Shiny.onInputChange(&#39;tab&#39;, &#39;widgets&#39;);">“Import
data”</a> (a spreadsheet/file on your machine, direct export from a
REDCap server, or a local file provided with a package) to get
<li><p>Import data (a spreadsheet/file on your machine, direct export
from a REDCap server, or a local file provided with a package) to get
started.</p></li>
<li><p>An <em>optional</em> step of data modification (change variable
classes and creating categorical variables (factors) from numeric or
@ -379,8 +379,16 @@ compare variables)</p></li>
depending on specified outcome variable</p></li>
<li><p>Evaluation of model assumptions</p></li>
</ul></li>
<li><p>Export the the analyses results as for MS Word or <a href="https://www.libreoffice.org/">LibreOffice</a>.</p></li>
<li><p>Export the the analyses results for MS Word or <a href="https://www.libreoffice.org/">LibreOffice</a> as well as the data
with preserved metadata.</p></li>
</ol>
<p>Have a look at the <a href>documentations page</a> for further
project description. If you’re interested in the source code, then go
on, <a href="https://github.com/agdamsbo/freesearcheR">have a
look</a>!</p>
<p>If you encounter anything strange or the app doesn’t act as expected.
Please <a href="https://github.com/agdamsbo/freesearcheR/issues">report
on Github</a>.</p>
</div>

4
inst/apps/data_analysis_modules/www/intro.md
View file

@ -19,3 +19,7 @@ There are four simple steps to go through (see corresponding tabs in the top):
- Evaluation of model assumptions
4. Export the the analyses results for MS Word or [LibreOffice](https://www.libreoffice.org/) as well as the data with preserved metadata.
Have a look at the [documentations page]() for further project description. If you're interested in the source code, then go on, [have a look](https://github.com/agdamsbo/freesearcheR)!
If you encounter anything strange or the app doesn't act as expected. Please [report on Github](https://github.com/agdamsbo/freesearcheR/issues).