updated docs

This commit is contained in:
Andreas Gammelgaard Damsbo 2025-07-22 20:00:41 +02:00
commit f60930cc03
No known key found for this signature in database
16 changed files with 1311 additions and 1298 deletions

View file

@ -1,7 +1,7 @@
########
#### Current file: /Users/au301842/FreesearchR/app/libs.R
#### Current file: /Users/au301842/FreesearchR/app/libs.R
########
library(shiny)
@ -40,20 +40,20 @@ library(rlang)
########
#### Current file: /Users/au301842/FreesearchR/app/functions.R
#### Current file: /Users/au301842/FreesearchR/app/functions.R
########
########
#### Current file: /Users/au301842/FreesearchR/R//app_version.R
#### Current file: /Users/au301842/FreesearchR/R//app_version.R
########
app_version <- function()'25.7.2'
########
#### Current file: /Users/au301842/FreesearchR/R//baseline_table.R
#### Current file: /Users/au301842/FreesearchR/R//baseline_table.R
########
#' Print a flexible baseline characteristics table
@ -138,7 +138,7 @@ create_baseline <- function(data, ..., by.var, add.p = FALSE, add.overall = FALS
########
#### Current file: /Users/au301842/FreesearchR/R//contrast_text.R
#### Current file: /Users/au301842/FreesearchR/R//contrast_text.R
########
#' @title Contrast Text Color
@ -194,7 +194,7 @@ contrast_text <- function(background,
########
#### Current file: /Users/au301842/FreesearchR/R//correlations-module.R
#### Current file: /Users/au301842/FreesearchR/R//correlations-module.R
########
#' Data correlations evaluation module
@ -339,7 +339,7 @@ sentence_paste <- function(data, and.str = "and") {
########
#### Current file: /Users/au301842/FreesearchR/R//create-column-mod.R
#### Current file: /Users/au301842/FreesearchR/R//create-column-mod.R
########
#' @title Create new column
@ -782,7 +782,7 @@ make_choices_with_infos <- function(data) {
########
#### Current file: /Users/au301842/FreesearchR/R//custom_SelectInput.R
#### Current file: /Users/au301842/FreesearchR/R//custom_SelectInput.R
########
#' A selectizeInput customized for data frames with column labels
@ -976,7 +976,7 @@ vectorSelectInput <- function(inputId,
########
#### Current file: /Users/au301842/FreesearchR/R//cut-variable-dates.R
#### Current file: /Users/au301842/FreesearchR/R//cut-variable-dates.R
########
#' Extended cutting function with fall-back to the native base::cut
@ -1595,7 +1595,7 @@ plot_histogram <- function(data, column=NULL, bins = 30, breaks = NULL, color =
########
#### Current file: /Users/au301842/FreesearchR/R//data_plots.R
#### Current file: /Users/au301842/FreesearchR/R//data_plots.R
########
# source(here::here("functions.R"))
@ -2445,7 +2445,7 @@ clean_common_axis <- function(p, axis) {
########
#### Current file: /Users/au301842/FreesearchR/R//data-import.R
#### Current file: /Users/au301842/FreesearchR/R//data-import.R
########
data_import_ui <- function(id) {
@ -2602,7 +2602,7 @@ data_import_demo_app <- function() {
########
#### Current file: /Users/au301842/FreesearchR/R//data-summary.R
#### Current file: /Users/au301842/FreesearchR/R//data-summary.R
########
#' Data summary module
@ -3000,7 +3000,7 @@ get_var_icon <- function(data,class.type=c("class","type")){
########
#### Current file: /Users/au301842/FreesearchR/R//datagrid-infos-mod.R
#### Current file: /Users/au301842/FreesearchR/R//datagrid-infos-mod.R
########
@ -3349,7 +3349,7 @@ construct_col_summary <- function(data) {
########
#### Current file: /Users/au301842/FreesearchR/R//helpers.R
#### Current file: /Users/au301842/FreesearchR/R//helpers.R
########
#' Wrapper function to get function from character vector referring to function from namespace. Passed to 'do.call()'
@ -4023,14 +4023,14 @@ simple_snake <- function(data){
########
#### Current file: /Users/au301842/FreesearchR/R//hosted_version.R
#### Current file: /Users/au301842/FreesearchR/R//hosted_version.R
########
hosted_version <- function()'v25.7.2-250704'
hosted_version <- function()'v25.7.2-250722'
########
#### Current file: /Users/au301842/FreesearchR/R//html_dependency_freesearchr.R
#### Current file: /Users/au301842/FreesearchR/R//html_dependency_freesearchr.R
########
html_dependency_FreesearchR <- function() {
@ -4045,7 +4045,7 @@ html_dependency_FreesearchR <- function() {
########
#### Current file: /Users/au301842/FreesearchR/R//import-file-ext.R
#### Current file: /Users/au301842/FreesearchR/R//import-file-ext.R
########
#' @title Import data from a file
@ -4655,7 +4655,7 @@ import_file_demo_app <- function() {
########
#### Current file: /Users/au301842/FreesearchR/R//launch_FreesearchR.R
#### Current file: /Users/au301842/FreesearchR/R//launch_FreesearchR.R
########
#' Easily launch the FreesearchR app
@ -4686,7 +4686,7 @@ launch_FreesearchR <- function(...){
########
#### Current file: /Users/au301842/FreesearchR/R//missings-module.R
#### Current file: /Users/au301842/FreesearchR/R//missings-module.R
########
#' Data correlations evaluation module
@ -4835,7 +4835,7 @@ compare_missings <- function(data,by_var){
########
#### Current file: /Users/au301842/FreesearchR/R//plot_box.R
#### Current file: /Users/au301842/FreesearchR/R//plot_box.R
########
#' Beautiful box plot(s)
@ -4934,7 +4934,7 @@ plot_box_single <- function(data, pri, sec=NULL, seed = 2103) {
########
#### Current file: /Users/au301842/FreesearchR/R//plot_euler.R
#### Current file: /Users/au301842/FreesearchR/R//plot_euler.R
########
#' Area proportional venn diagrams
@ -5075,7 +5075,7 @@ plot_euler_single <- function(data) {
########
#### Current file: /Users/au301842/FreesearchR/R//plot_hbar.R
#### Current file: /Users/au301842/FreesearchR/R//plot_hbar.R
########
#' Nice horizontal stacked bars (Grotta bars)
@ -5175,7 +5175,7 @@ vertical_stacked_bars <- function(data,
########
#### Current file: /Users/au301842/FreesearchR/R//plot_ridge.R
#### Current file: /Users/au301842/FreesearchR/R//plot_ridge.R
########
#' Plot nice ridge plot
@ -5209,7 +5209,7 @@ plot_ridge <- function(data, x, y, z = NULL, ...) {
########
#### Current file: /Users/au301842/FreesearchR/R//plot_sankey.R
#### Current file: /Users/au301842/FreesearchR/R//plot_sankey.R
########
#' Readying data for sankey plot
@ -5442,7 +5442,7 @@ plot_sankey_single <- function(data, pri, sec, color.group = c("pri", "sec"), co
########
#### Current file: /Users/au301842/FreesearchR/R//plot_scatter.R
#### Current file: /Users/au301842/FreesearchR/R//plot_scatter.R
########
#' Beautiful violin plot
@ -5477,7 +5477,7 @@ plot_scatter <- function(data, pri, sec, ter = NULL) {
########
#### Current file: /Users/au301842/FreesearchR/R//plot_violin.R
#### Current file: /Users/au301842/FreesearchR/R//plot_violin.R
########
#' Beatiful violin plot
@ -5512,7 +5512,7 @@ plot_violin <- function(data, pri, sec, ter = NULL) {
########
#### Current file: /Users/au301842/FreesearchR/R//plot-download-module.R
#### Current file: /Users/au301842/FreesearchR/R//plot-download-module.R
########
plot_download_ui <- regression_ui <- function(id, ...) {
@ -5593,7 +5593,7 @@ plot_download_server <- function(id,
########
#### Current file: /Users/au301842/FreesearchR/R//redcap_read_shiny_module.R
#### Current file: /Users/au301842/FreesearchR/R//redcap_read_shiny_module.R
########
#' Shiny module to browser and export REDCap data
@ -6289,7 +6289,7 @@ redcap_demo_app <- function() {
########
#### Current file: /Users/au301842/FreesearchR/R//regression_model.R
#### Current file: /Users/au301842/FreesearchR/R//regression_model.R
########
#' Create a regression model programatically
@ -7016,7 +7016,7 @@ regression_model_uv_list <- function(data,
########
#### Current file: /Users/au301842/FreesearchR/R//regression_plot.R
#### Current file: /Users/au301842/FreesearchR/R//regression_plot.R
########
#' Regression coef plot from gtsummary. Slightly modified to pass on arguments
@ -7182,7 +7182,7 @@ symmetrical_scale_x_log10 <- function(plot, breaks = c(1, 2, 3, 5, 10), ...) {
########
#### Current file: /Users/au301842/FreesearchR/R//regression_table.R
#### Current file: /Users/au301842/FreesearchR/R//regression_table.R
########
#' Create table of regression model
@ -7371,7 +7371,7 @@ tbl_merge <- function(data) {
########
#### Current file: /Users/au301842/FreesearchR/R//regression-module.R
#### Current file: /Users/au301842/FreesearchR/R//regression-module.R
########
### On rewriting this module
@ -8059,7 +8059,7 @@ regression_server <- function(id,
########
#### Current file: /Users/au301842/FreesearchR/R//report.R
#### Current file: /Users/au301842/FreesearchR/R//report.R
########
#' Split vector by an index and embed addition
@ -8147,7 +8147,7 @@ modify_qmd <- function(file, format) {
########
#### Current file: /Users/au301842/FreesearchR/R//syntax_highlight.R
#### Current file: /Users/au301842/FreesearchR/R//syntax_highlight.R
########
## Inpiration:
@ -8178,7 +8178,7 @@ html_code_wrap <- function(string,lang="r"){
########
#### Current file: /Users/au301842/FreesearchR/R//theme.R
#### Current file: /Users/au301842/FreesearchR/R//theme.R
########
#' Custom theme based on unity
@ -8297,7 +8297,7 @@ gg_theme_export <- function() {
########
#### Current file: /Users/au301842/FreesearchR/R//ui_elements.R
#### Current file: /Users/au301842/FreesearchR/R//ui_elements.R
########
#' FreesearchR UI elements list
@ -8906,7 +8906,7 @@ if (!is.null(selection)){
########
#### Current file: /Users/au301842/FreesearchR/R//update-factor-ext.R
#### Current file: /Users/au301842/FreesearchR/R//update-factor-ext.R
########
@ -9203,7 +9203,7 @@ winbox_update_factor <- function(id,
########
#### Current file: /Users/au301842/FreesearchR/R//update-variables-ext.R
#### Current file: /Users/au301842/FreesearchR/R//update-variables-ext.R
########
#' Select, rename and convert variables
@ -10015,7 +10015,7 @@ clean_date <- function(data) {
########
#### Current file: /Users/au301842/FreesearchR/R//visual_summary.R
#### Current file: /Users/au301842/FreesearchR/R//visual_summary.R
########
#' Data correlations evaluation module
@ -10312,7 +10312,7 @@ unique_short <- function(data, max = 15) {
########
#### Current file: /Users/au301842/FreesearchR/R//wide2long.R
#### Current file: /Users/au301842/FreesearchR/R//wide2long.R
########
#' Alternative pivoting method for easily pivoting based on name pattern
@ -10471,7 +10471,7 @@ grepl_fix <- function(data, pattern, type = c("prefix", "infix", "suffix")) {
########
#### Current file: /Users/au301842/FreesearchR/dev/header_include.R
#### Current file: /Users/au301842/FreesearchR/dev/header_include.R
########
header_include <- function(){
@ -10482,7 +10482,7 @@ header_include <- function(){
########
#### Current file: /Users/au301842/FreesearchR/dev/dev_banner.R
#### Current file: /Users/au301842/FreesearchR/dev/dev_banner.R
########
dev_banner <- function(){
@ -10491,7 +10491,7 @@ dev_banner <- function(){
########
#### Current file: /Users/au301842/FreesearchR/app/ui.R
#### Current file: /Users/au301842/FreesearchR/app/ui.R
########
# ns <- NS(id)
@ -10561,7 +10561,7 @@ ui <- bslib::page_fixed(
########
#### Current file: /Users/au301842/FreesearchR/app/server.R
#### Current file: /Users/au301842/FreesearchR/app/server.R
########
data(mtcars)
@ -10771,18 +10771,16 @@ server <- function(input, output, session) {
shiny::updateActionButton(inputId = "modal_visual_overview", disabled = TRUE)
shiny::updateActionButton(inputId = "act_eval", disabled = TRUE)
bslib::nav_hide(id = "main_panel",
target = "nav_visuals")
# bslib::nav_hide(id = "main_panel",
# target = "nav_visuals")
} else {
shiny::updateActionButton(inputId = "act_start", disabled = FALSE)
shiny::updateActionButton(inputId = "modal_browse", disabled = FALSE)
shiny::updateActionButton(inputId = "modal_visual_overview", disabled = FALSE)
shiny::updateActionButton(inputId = "act_eval", disabled = FALSE)
bslib::nav_show(id = "main_panel",
target = "nav_visuals")
# bslib::nav_show(id = "main_panel",
# target = "nav_visuals")
}
})
@ -11376,7 +11374,7 @@ server <- function(input, output, session) {
########
#### Current file: /Users/au301842/FreesearchR/app/launch.R
#### Current file: /Users/au301842/FreesearchR/app/launch.R
########
shinyApp(ui, server)

View file

@ -1,31 +1,19 @@
# Welcome <img style="float: right;" src="FreesearchR-logo.png">
# Welcome <img src="FreesearchR-logo.png" style="float: right;"/>
This is the ***FreesearchR*** data analysis tool. We intend ***FreesearchR*** to be a free tool for easy data evaluation and analysis. If you need more advanced tools, start with ***FreesearchR*** and then you'll probably be better off using *R* or similar directly.
This is the ***FreesearchR*** data analysis tool, a free tool for basic data evaluation and analysis. If you need more advanced tools, start with ***FreesearchR*** and then you'll probably be better off using *R* or similar directly.
Here is a brief summary of the functions:
With this tool you can:
1. **Import data** from a spreadsheet/file on your machine, direct export from a REDCap server, sample data or data from a your local environment if run locally.
1. **Import data** from a spreadsheet/file on your machine, directly from a [REDCap](https://projectredcap.org/ "Read more on the data capture tool REDCap") server, try it with sample data or access data directly [if run in R locally](https://agdamsbo.github.io/FreesearchR//#run-locally-on-your-own-machine "Read about running FreesearchR on your local machine")
1. **Data inspection** and **modification** like modifying variables or creating new (categorical from numeric or time data, or completely new variables from the data)
2. **Prepare** data for analysis by filtering data, modifying variables or create new variables
1. **Evaluate data** using descriptive analyses methods and inspect cross-correlations
3. **Evaluate data** using descriptive analyses methods and inspect cross-correlations as well as [missing observations](https://agdamsbo.github.io/FreesearchR/articles/missingness.html "Read more about missing data")
1. **Create and export simple, clean plots** for data overview and insights
4. **Visualise data** by [creating simple, clean plots](https://agdamsbo.github.io/FreesearchR/articles/visuals.html "See available plot types") for overview and quick insights
1. **Create regression simple models** for even more advanced data analyses
5. **Create simple regression models** for even more advanced data analyses
- Linear, dichotomous or ordinal logistic regression will be used depending on specified outcome variable
- Plot regression analysis coefficients
6. **Download** results as a report, get the modified data set and save the code for learning and to reproduce the results later
- Evaluate model assumptions
1. **Export results**
- Descriptive and regression analyses results for MS Word or [LibreOffice](https://www.libreoffice.org/)
- Modified data with preserved metadata
- Code to recreate all steps locally
The full [project documentation is here](https://agdamsbo.github.io/FreesearchR/) where you'll find detailed description of the app and link to the source code! If you want to [share feedback, please follow this link to a simple survey](https://redcap.au.dk/surveys/?s=JPCLPTXYDKFA8DA8).
The full [project documentation is here](https://agdamsbo.github.io/FreesearchR/) where you'll find detailed descriptions of the app and link to the source code! If you want to [share feedback, please follow this link to a simple survey](https://redcap.au.dk/surveys/?s=JPCLPTXYDKFA8DA8).