mirror of
https://github.com/agdamsbo/FreesearchR.git
synced 2025-09-12 09:59:39 +02:00
200 lines
14 KiB
HTML
200 lines
14 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>A free and open-source browser based data analysis tool for researchers with publication ready output • FreesearchR</title>
|
|
<!-- favicons --><link rel="icon" type="image/png" sizes="96x96" href="favicon-96x96.png">
|
|
<link rel="icon" type="”image/svg+xml”" href="favicon.svg">
|
|
<link rel="apple-touch-icon" sizes="180x180" href="apple-touch-icon.png">
|
|
<link rel="icon" sizes="any" href="favicon.ico">
|
|
<link rel="manifest" href="site.webmanifest">
|
|
<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="A free and open-source browser based data analysis tool for researchers with publication ready output">
|
|
<meta name="description" content="Easily evaluate and analysis clinical health data in your browser on a server or on your own device. Import data from multiple sources, summarise, modify and visualise data and export key metrics and regression analysis results in a publication ready format.">
|
|
<meta property="og:description" content="Easily evaluate and analysis clinical health data in your browser on a server or on your own device. Import data from multiple sources, summarise, modify and visualise data and export key metrics and regression analysis results in a publication ready format.">
|
|
<meta property="og:image" content="https://agdamsbo.github.io/FreesearchR/logo.png">
|
|
<script defer src="https://stats.freesearchr.org/script.js" data-website-id="85bfd1e8-2cbe-4a4a-aa34-1dfb2960905b"></script>
|
|
</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.5.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 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/data-types.html">Data types</a></li>
|
|
<li><a class="dropdown-item" href="articles/session.html">Session info</a></li>
|
|
<li><a class="dropdown-item" href="articles/visuals.html">On visuals</a></li>
|
|
</ul>
|
|
</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&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-home">
|
|
<div class="row">
|
|
<main id="main" class="col-md-9"><div class="section level1">
|
|
<div class="page-header">
|
|
<img src="logo.png" class="logo" alt=""><h1 id="freesearchr-">FreesearchR
|
|
<a class="anchor" aria-label="anchor" href="#freesearchr-"></a>
|
|
</h1>
|
|
</div>
|
|
<!-- badges: start -->
|
|
|
|
<p>The <a href="https://app.freesearchr.org" class="external-link"><strong><em>FreesearchR</em></strong></a> is a simple, clinical health data exploration and analysis tool to democratise clinical research by assisting any researcher to easily evaluate and analyse data and export publication ready results.</p>
|
|
<p><a href="https://app.freesearchr.org" class="external-link"><strong><em>FreesearchR</em></strong></a> is free and open-source, and is <a href="https://app.freesearchr.org" class="external-link">accessible in your web browser through this link</a>. The app can also run locally, please see below.</p>
|
|
<p>All feedback is welcome and can be shared as a GitHub issue. Any suggestions on collaboration is much welcomed. Please reach out!</p>
|
|
<div class="float">
|
|
<img src="./reference/figures/demo.gif" alt="FreesearchR demo"><div class="figcaption">FreesearchR demo</div>
|
|
</div>
|
|
<div class="section level2">
|
|
<h2 id="motivation">Motivation<a class="anchor" aria-label="anchor" href="#motivation"></a>
|
|
</h2>
|
|
<p>This app has the following simple goals:</p>
|
|
<ol style="list-style-type: decimal">
|
|
<li><p>help the health clinician getting an overview of data in quality improvement projects and clinical research</p></li>
|
|
<li><p>help learners get a good start analysing data and coding in <em>R</em></p></li>
|
|
<li><p>ease quick data overview and basic visualisations for any clinical researcher</p></li>
|
|
</ol>
|
|
</div>
|
|
<div class="section level2">
|
|
<h2 id="sec-run-locally">Run locally on your own machine<a class="anchor" aria-label="anchor" href="#sec-run-locally"></a>
|
|
</h2>
|
|
<p>The <strong><em>FreesearchR</em></strong> app can also run on your own machine with no data transmitted anywhere. Any data.frame available in the global environment will be accessible from the interface. Just follow the below steps:</p>
|
|
<ol style="list-style-type: decimal">
|
|
<li><p><strong>Requirement:</strong> You need to have <a href="https://www.r-project.org/" class="external-link"><em>R</em> installed</a> and possibly an editor like <a href="https://posit.co/download/rstudio-desktop/" class="external-link">RStudio</a>.</p></li>
|
|
<li>
|
|
<p>Then open the <em>R</em> console and copy/paste the following code, that will install the <a href="https://devtools.r-lib.org/" class="external-link">devtools</a> package and then the <a href="https://github.com/agdamsbo/FreesearchR" class="external-link">FreesearchR</a> <em>R</em>-package with its dependencies:</p>
|
|
<pre><code><span><span class="kw"><a href="https://rdrr.io/r/base/library.html" class="external-link">require</a></span><span class="op">(</span><span class="st"><a href="https://devtools.r-lib.org/" class="external-link">"devtools"</a></span><span class="op">)</span></span>
|
|
<span><span class="fu">devtools</span><span class="fu">::</span><span class="fu"><a href="https://remotes.r-lib.org/reference/install_github.html" class="external-link">install_github</a></span><span class="op">(</span><span class="st">"agdamsbo/FreesearchR"</span><span class="op">)</span></span>
|
|
<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"># By loading mtcars to the environment, it will be available</span></span>
|
|
<span><span class="co"># in the interface like any other data.frame</span></span>
|
|
<span><span class="fu"><a href="https://rdrr.io/r/utils/data.html" class="external-link">data</a></span><span class="op">(</span><span class="va">mtcars</span><span class="op">)</span></span>
|
|
<span><span class="fu"><a href="reference/launch_FreesearchR.html">launch_FreesearchR</a></span><span class="op">(</span><span class="op">)</span></span></code></pre>
|
|
</li>
|
|
</ol>
|
|
</div>
|
|
<div class="section level2">
|
|
<h2 id="code-of-conduct">Code of Conduct<a class="anchor" aria-label="anchor" href="#code-of-conduct"></a>
|
|
</h2>
|
|
<p>Please note that the <strong><em>FreesearchR</em></strong> project is published with a <a href="https://contributor-covenant.org/version/2/1/CODE_OF_CONDUCT.html" class="external-link">Contributor Code of Conduct</a>. By contributing to this project, you agree to abide by its terms.</p>
|
|
</div>
|
|
<div class="section level2">
|
|
<h2 id="acknowledgements">Acknowledgements<a class="anchor" aria-label="anchor" href="#acknowledgements"></a>
|
|
</h2>
|
|
<p>Like any other project, this project was never possible without the great work of others. These are some of the sources and packages I have used:</p>
|
|
<ul>
|
|
<li><p>The <strong><em>FreesearchR</em></strong> app is build with <a href="https://shiny.posit.co/" class="external-link">Shiny</a> and based on <a href="https://www.r-project.org/" class="external-link"><em>R</em></a>.</p></li>
|
|
<li><p><a href="https://www.danieldsjoberg.com/gtsummary/" class="external-link">gtsummary</a>: superb and flexible way to create publication-ready analytical and summary tables.</p></li>
|
|
<li><p><a href="https://github.com/dreamRs" class="external-link">dreamRs</a>: maintainers of a broad selection of great extensions and tools for <a href="https://shiny.posit.co/" class="external-link">Shiny</a>.</p></li>
|
|
<li><p><a href="https://easystats.github.io/easystats/" class="external-link">easystats</a>: the <a href="https://easystats.github.io/performance/articles/check_model.html" class="external-link"><code>performance::check_model()</code></a> function was central in sparking the idea to create a data analysis tool.</p></li>
|
|
<li><p><a href="https://biogen-inc.github.io/IDEAFilter/" class="external-link">IDEAfilter</a>: a visually appealing data filter function based on the <a href="https://github.com/dgkf/shinyDataFilter" class="external-link">{shinyDataFilter}</a>.</p></li>
|
|
</ul>
|
|
<p>This project was all written by a human and not by any AI-based tools.</p>
|
|
<p>The online <strong><em>FreesearchR</em></strong> app contains a tracking script, transmitting minimal data on usage. No uploaded data is transmitted anywhere. Have a look at the <a href="https://analytics.gdamsbo.dk/share/2i4BNpMcDMB9lJvF/agdamsbo.shinyapps.io" class="external-link">tracking data here</a>. No tracking data is sent running the app locally (see above).</p>
|
|
</div>
|
|
</div>
|
|
</main><aside class="col-md-3"><div class="links">
|
|
<h2 data-toc-skip>Links</h2>
|
|
<ul class="list-unstyled">
|
|
<li><a href="https://github.com/agdamsbo/FreesearchR/" class="external-link">Browse source code</a></li>
|
|
<li><a href="https://github.com/agdamsbo/FreesearchR/issues" class="external-link">Report a bug</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="license">
|
|
<h2 data-toc-skip>License</h2>
|
|
<ul class="list-unstyled">
|
|
<li><a href="LICENSE.html">Full license</a></li>
|
|
<li><small>AGPL (>= 3)</small></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="community">
|
|
<h2 data-toc-skip>Community</h2>
|
|
<ul class="list-unstyled">
|
|
<li><a href="CODE_OF_CONDUCT.html">Code of conduct</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="citation">
|
|
<h2 data-toc-skip>Citation</h2>
|
|
<ul class="list-unstyled">
|
|
<li><a href="authors.html#citation">Citing FreesearchR</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="developers">
|
|
<h2 data-toc-skip>Developers</h2>
|
|
<ul class="list-unstyled">
|
|
<li>Andreas Gammelgaard Damsbo <br><small class="roles"> Author, maintainer </small> <a href="https://orcid.org/0000-0002-7559-1154" target="orcid.widget" aria-label="ORCID" class="external-link"><span class="fab fa-orcid orcid" aria-hidden="true"></span></a> </li>
|
|
<li><a href="authors.html">More about authors...</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div class="dev-status">
|
|
<h2 data-toc-skip>Dev status</h2>
|
|
<ul class="list-unstyled">
|
|
<li><a href="https://lifecycle.r-lib.org/articles/stages.html#experimental" class="external-link"><img src="https://img.shields.io/badge/lifecycle-experimental-orange.svg" alt="Lifecycle: experimental"></a></li>
|
|
<li><a href="https://doi.org/10.5281/zenodo.14527429" class="external-link"><img src="https://zenodo.org/badge/DOI/10.5281/zenodo.14527429.svg" alt="DOI"></a></li>
|
|
<li><a href="https://github.com/agdamsbo/FreesearchR/actions/workflows/rhub.yaml" class="external-link"><img src="https://github.com/agdamsbo/FreesearchR/actions/workflows/rhub.yaml/badge.svg" alt="rhub"></a></li>
|
|
<li><a href="https://agdamsbo.shinyapps.io/FreesearchR/" class="external-link"><img src="https://img.shields.io/badge/Shiny-shinyapps.io-blue?style=flat&labelColor=white&logo=RStudio&logoColor=blue" alt="FreesearchR"></a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
</aside>
|
|
</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.2.</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>
|