2025-03-19 08:31:56 +00:00
<!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 > FreesearchR • 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.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 = "FreesearchR" >
< / 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 >
2025-04-02 09:48:38 +00:00
< small class = "nav-text text-muted me-auto" data-bs-toggle = "tooltip" data-bs-placement = "bottom" title = "" > 25.4.1< / small >
2025-03-19 08:31:56 +00:00
< 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 = "../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& 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 >
2025-03-19 12:28:24 +00:00
< 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 >
2025-03-19 08:31:56 +00:00
< / ul >
< / div >
< / div >
< / nav > < div class = "container template-article" >
< div class = "row" >
< main id = "main" class = "col-md-9" > < div class = "page-header" >
< h1 > FreesearchR< / h1 >
2025-03-19 12:28:24 +00:00
< small class = "dont-index" > Source: < a href = "https://github.com/agdamsbo/FreesearchR/blob/main/vignettes/FreesearchR.Rmd" class = "external-link" > < code > vignettes/FreesearchR.Rmd< / code > < / a > < / small >
2025-03-19 08:31:56 +00:00
< div class = "d-none name" > < code > FreesearchR.Rmd< / code > < / div >
< / div >
< div class = "section level2" >
< h2 id = "getting-started-with-freesearchr" > Getting started with < strong > < em > FreesearchR< / em > < / strong > < a class = "anchor" aria-label = "anchor" href = "#getting-started-with-freesearchr" > < / a >
< / h2 >
< p > Below is a simple walk-trough and basic instructions for the
functions on the FreesearchR app.< / p >
< div class = "section level3" >
< h3 id = "launching" > Launching< a class = "anchor" aria-label = "anchor" href = "#launching" > < / a >
< / h3 >
< p > The easiest way to get started is to launch < a href = "https://agdamsbo.shinyapps.io/freesearcheR/" class = "external-link" > the hosted version of
the app on shinyapps.io (click this link)< / a > .< / p >
< p > Additionally you have the option to run the app locally with access
to any data in your current working environment.< / p >
< p > To do this, open < em > R< / em > (or RStudio or similar), and run the
following code to install the latest version of
< strong > < em > FreesearchR< / em > < / strong > and launch the app:< / p >
< 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" > require< / a > < / span > < span class = "op" > (< / span > < span class = "st" > < a href = "https://pak.r-lib.org/" class = "external-link" > "pak"< / a > < / span > < span class = "op" > )< / span > < / span >
< span > < span class = "fu" > pak< / span > < span class = "fu" > ::< / span > < span class = "fu" > < a href = "https://pak.r-lib.org/reference/pak.html" class = "external-link" > pak< / a > < / span > < span class = "op" > (< / span > < span class = "st" > "agdamsbo/FreesearchR"< / span > < span class = "op" > )< / span > < / span >
2025-03-19 12:28:24 +00:00
< 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 >
2025-03-19 08:31:56 +00:00
< span > < span class = "fu" > FreesearchR< / span > < span class = "fu" > ::< / 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 > < / div >
< p > As a small note, a standalone Windows app version is on the drawing
board as well, but no time frame is available.< / p >
< / div >
< div class = "section level3" >
< h3 id = "importing-data" > Importing data< a class = "anchor" aria-label = "anchor" href = "#importing-data" > < / a >
< / h3 >
< p > Once in the app and in the “< em > Import< / em > ”, you have three options
available for importing data: file upload, REDCap server export and
local or sample data.< / p >
< p > After choosing a data source, you can set a threshold to filter data
be completenes and further manually specify variables to include for
analyses.< / p >
< div class = "section level4" >
< h4 id = "file-upload" > File upload< a class = "anchor" aria-label = "anchor" href = "#file-upload" > < / a >
< / h4 >
< p > Currently several data file formats are supported for easy import
(csv, txt, xls(x), ods, rds, dta). If importing workbooks (xls(x) or
ods), you are prompted to specify sheet(s) to import. If choosing
multiple sheets, these are automatically merged by common variable(s),
so please make sure that key variables are correctly named
identically.< / p >
< / div >
< div class = "section level4" >
< h4 id = "redcap-server-export" > REDCap server export< a class = "anchor" aria-label = "anchor" href = "#redcap-server-export" > < / a >
< / h4 >
< / div >
< div class = "section level4" >
< h4 id = "local-or-sample-data" > Local or sample data< a class = "anchor" aria-label = "anchor" href = "#local-or-sample-data" > < / a >
< / h4 >
< / div >
< / div >
< div class = "section level3" >
< h3 id = "evaluate" > Evaluate< a class = "anchor" aria-label = "anchor" href = "#evaluate" > < / a >
< / h3 >
< div class = "section level4" >
< h4 id = "baseline" > Baseline< a class = "anchor" aria-label = "anchor" href = "#baseline" > < / a >
< / h4 >
< / div >
< div class = "section level4" >
< h4 id = "correlation-matrix" > Correlation matrix< a class = "anchor" aria-label = "anchor" href = "#correlation-matrix" > < / a >
< / h4 >
< / div >
< / div >
< div class = "section level3" >
< h3 id = "visualise" > Visualise< a class = "anchor" aria-label = "anchor" href = "#visualise" > < / a >
< / h3 >
< ul >
< li > Would be nice to have a table of possible plots, their description
and data options< / li >
< / ul >
< / div >
< div class = "section level3" >
< h3 id = "regression" > Regression< a class = "anchor" aria-label = "anchor" href = "#regression" > < / a >
< / h3 >
< / div >
< div class = "section level3" >
< h3 id = "download" > Download< a class = "anchor" aria-label = "anchor" href = "#download" > < / a >
< / h3 >
< div class = "section level4" >
< h4 id = "report" > Report< a class = "anchor" aria-label = "anchor" href = "#report" > < / a >
< / h4 >
< / div >
< div class = "section level4" >
< h4 id = "data" > Data< a class = "anchor" aria-label = "anchor" href = "#data" > < / a >
< / h4 >
< / div >
< div class = "section level4" >
< h4 id = "code" > Code< a class = "anchor" aria-label = "anchor" href = "#code" > < / a >
< / h4 >
< / div >
< / div >
< / div >
< / main > < aside class = "col-md-3" > < nav id = "toc" aria-label = "Table of contents" > < h2 > On this page< / h2 >
< / nav > < / 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.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 >
