Here’s a polished and restructured version of your README section for clarity, conciseness, and user-friendliness:
-
Run Locally on Your Own Machine
+Run locally on your own machine
-
The FreesearchR app can be run locally on your machine, ensuring no data is transmitted externally. Below are the available options for setup and configuration.
+
The FreesearchR app can also run on your own machine with no data transmitted anywhere. Blow are the available options.
-
Configuration & Data Loading
+Run from R (or RStduio)
-
The app can be configured either by passing a named list to run_app() or by setting environment variables in a Docker Compose file. The following variables control data access and display behavior. If no values are provided, the app will use the defaults listed below.
-
Configuration Variables
-
-
-
-
-
-
-
-
-
-INCLUDE_GLOBALENV |
-Load datasets already present in the global R environment into the app |
-FALSE |
-
-
-DATA_LIMIT_DEFAULT |
-Default number of observations for previewing or working with a dataset |
-10,000 |
-
-
-DATA_LIMIT_UPPER |
-Maximum number of observations a user can set for the upper limit. If set to 0, no uppper limit is applied. |
-100,000 |
-
-
-DATA_LIMIT_LOWER |
-Minimum number of observations a user can set for the lower limit |
-1 |
-
-
-
-
-
-
Run from R (or RStudio)
-
-
If you’re working with data in R, FreesearchR is a quick and easy tool for exploratory analysis.
+
Working with data in R, FreesearchR is a quick and easy tool to get overview and perform the first explorative analyses to get you going.
+
Any data available in the your R session will be available to the FreesearchR app. Just follow the below steps to get going:
-Requirement: Ensure you have R installed, and optionally an editor like RStudio.
Requirement: You need to have R installed and possibly an editor like RStudio.
-
-
Open the R console and run the following code to install the FreesearchR package and launch the app:
-
+launch_FreesearchR()
-
All the variables specified above can also be passed to the app on launch from R. Set DATA_LIMIT_UPPER=0 to remove upper data limit. This limit is set to protect the online app version from choking and crashing on large data sets.
-
Running with Docker Compose
+Running with docker compose
-
For advanced users, you can deploy FreesearchR using Docker. A data folder can be mounted to /app/data to automatically load supported file types (.csv, .tsv, .txt, .xls, .xlsx, .ods, .dta, .rds) at startup.
-
To mount a local data folder, add a volumes entry to your docker-compose.yml file:
-
services:
- shiny:
- image: ghcr.io/agdamsbo/freesearchr:latest
- volumes:
- - ./data:/app/data:ro
- environment:
- - INCLUDE_GLOBALENV=FALSE
- - DATA_LIMIT_DEFAULT=10000
- - DATA_LIMIT_UPPER=100000
- - DATA_LIMIT_LOWER=1
- ports:
- - '3838:3838'
- restart: on-failure
-
-The :ro flag mounts the folder as read-only, preventing the app from modifying your original data files.
If no volume is mounted, the app will start without any preloaded datasets.
+
For advanced users, wanting to deploy the FreesearchR app to run anywhere, a docker image is available.
+
Below is the minimal docker_compose.yml file:
+
services:
+ freesearchr:
+ image: ghcr.io/agdamsbo/freesearchr:latest
+ ports:
+ - '3838:3838'
+ restart: on-failure
diff --git a/index.md b/index.md
index 8eb18eca..ccfaaf06 100644
--- a/index.md
+++ b/index.md
@@ -29,89 +29,49 @@ This app has the following simple goals:
3. ease quick data overview and basic visualisations for any clinical
researcher
-Here’s a polished and restructured version of your README section for
-clarity, conciseness, and user-friendliness:
+## Run locally on your own machine
-## Run Locally on Your Own Machine
+The ***FreesearchR*** app can also run on your own machine with no data
+transmitted anywhere. Blow are the available options.
-The **FreesearchR** app can be run locally on your machine, ensuring no
-data is transmitted externally. Below are the available options for
-setup and configuration.
+### Run from R (or RStduio)
-### Configuration & Data Loading
+Working with data in R, FreesearchR is a quick and easy tool to get
+overview and perform the first explorative analyses to get you going.
-The app can be configured either by passing a named list to `run_app()`
-or by setting environment variables in a **Docker Compose** file. The
-following variables control data access and display behavior. If no
-values are provided, the app will use the defaults listed below.
+Any data available in the your R session will be available to the
+FreesearchR app. Just follow the below steps to get going:
-**Configuration Variables**
-
-| Variable | Description | Default |
-|----------------------|-------------------------------------------------------------------------------------------------------------|-----------|
-| `INCLUDE_GLOBALENV` | Load datasets already present in the global R environment into the app | `FALSE` |
-| `DATA_LIMIT_DEFAULT` | Default number of observations for previewing or working with a dataset | `10,000` |
-| `DATA_LIMIT_UPPER` | Maximum number of observations a user can set for the upper limit. If set to 0, no uppper limit is applied. | `100,000` |
-| `DATA_LIMIT_LOWER` | Minimum number of observations a user can set for the lower limit | `1` |
-
-### Run from R (or RStudio)
-
-If you’re working with data in R, **FreesearchR** is a quick and easy
-tool for exploratory analysis.
-
-1. **Requirement:** Ensure you have [R](https://www.r-project.org/)
- installed, and optionally an editor like
+1. **Requirement:** You need to have [*R*
+ installed](https://www.r-project.org/) and possibly an editor like
[RStudio](https://posit.co/download/rstudio-desktop/).
-2. Open the **R console** and run the following code to install the
- [FreesearchR](https://github.com/agdamsbo/FreesearchR) package and
- launch the app:
+2. Then open the *R* console and copy/paste the following code, that
+ will install the [devtools](https://devtools.r-lib.org/) package and
+ then the [FreesearchR](https://github.com/agdamsbo/FreesearchR)
+ *R*-package with its dependencies:
- ``` r
- if (!require("devtools")) install.packages("devtools")
- devtools::install_github("agdamsbo/FreesearchR")
- library(FreesearchR)
- # Load sample data (e.g., mtcars) to make it available in the app
- data(mtcars)
- launch_FreesearchR(INCLUDE_GLOBALENV=TRUE)
- ```
+ require("devtools")
+ devtools::install_github("agdamsbo/FreesearchR")
+ library(FreesearchR)
+ # By loading mtcars to the environment, it will be available
+ # in the interface like any other data.frame
+ data(mtcars)
+ launch_FreesearchR()
-All the variables specified above can also be passed to the app on
-launch from R. Set DATA_LIMIT_UPPER=0 to remove upper data limit. This
-limit is set to protect the online app version from choking and crashing
-on large data sets.
+### Running with docker compose
-### Running with Docker Compose
+For advanced users, wanting to deploy the FreesearchR app to run
+anywhere, a docker image is available.
-For advanced users, you can deploy **FreesearchR** using Docker. A data
-folder can be mounted to `/app/data` to automatically load supported
-file types (`.csv`, `.tsv`, `.txt`, `.xls`, `.xlsx`, `.ods`, `.dta`,
-`.rds`) at startup.
+Below is the minimal `docker_compose.yml` file:
-To mount a local data folder, add a `volumes` entry to your
-`docker-compose.yml` file:
-
-``` yaml
-services:
- shiny:
- image: ghcr.io/agdamsbo/freesearchr:latest
- volumes:
- - ./data:/app/data:ro
- environment:
- - INCLUDE_GLOBALENV=FALSE
- - DATA_LIMIT_DEFAULT=10000
- - DATA_LIMIT_UPPER=100000
- - DATA_LIMIT_LOWER=1
- ports:
- - '3838:3838'
- restart: on-failure
-```
-
-- The `:ro` flag mounts the folder as **read-only**, preventing the app
- from modifying your original data files.
-
-- If no volume is mounted, the app will start without any preloaded
- datasets.
+ services:
+ freesearchr:
+ image: ghcr.io/agdamsbo/freesearchr:latest
+ ports:
+ - '3838:3838'
+ restart: on-failure
## Code of Conduct
diff --git a/llms.txt b/llms.txt
index ff6bb63b..7f65ed50 100644
--- a/llms.txt
+++ b/llms.txt
@@ -29,89 +29,49 @@ This app has the following simple goals:
3. ease quick data overview and basic visualisations for any clinical
researcher
-Here’s a polished and restructured version of your README section for
-clarity, conciseness, and user-friendliness:
+## Run locally on your own machine
-## Run Locally on Your Own Machine
+The ***FreesearchR*** app can also run on your own machine with no data
+transmitted anywhere. Blow are the available options.
-The **FreesearchR** app can be run locally on your machine, ensuring no
-data is transmitted externally. Below are the available options for
-setup and configuration.
+### Run from R (or RStduio)
-### Configuration & Data Loading
+Working with data in R, FreesearchR is a quick and easy tool to get
+overview and perform the first explorative analyses to get you going.
-The app can be configured either by passing a named list to `run_app()`
-or by setting environment variables in a **Docker Compose** file. The
-following variables control data access and display behavior. If no
-values are provided, the app will use the defaults listed below.
+Any data available in the your R session will be available to the
+FreesearchR app. Just follow the below steps to get going:
-**Configuration Variables**
-
-| Variable | Description | Default |
-|----------------------|-------------------------------------------------------------------------------------------------------------|-----------|
-| `INCLUDE_GLOBALENV` | Load datasets already present in the global R environment into the app | `FALSE` |
-| `DATA_LIMIT_DEFAULT` | Default number of observations for previewing or working with a dataset | `10,000` |
-| `DATA_LIMIT_UPPER` | Maximum number of observations a user can set for the upper limit. If set to 0, no uppper limit is applied. | `100,000` |
-| `DATA_LIMIT_LOWER` | Minimum number of observations a user can set for the lower limit | `1` |
-
-### Run from R (or RStudio)
-
-If you’re working with data in R, **FreesearchR** is a quick and easy
-tool for exploratory analysis.
-
-1. **Requirement:** Ensure you have [R](https://www.r-project.org/)
- installed, and optionally an editor like
+1. **Requirement:** You need to have [*R*
+ installed](https://www.r-project.org/) and possibly an editor like
[RStudio](https://posit.co/download/rstudio-desktop/).
-2. Open the **R console** and run the following code to install the
- [FreesearchR](https://github.com/agdamsbo/FreesearchR) package and
- launch the app:
+2. Then open the *R* console and copy/paste the following code, that
+ will install the [devtools](https://devtools.r-lib.org/) package and
+ then the [FreesearchR](https://github.com/agdamsbo/FreesearchR)
+ *R*-package with its dependencies:
- ``` r
- if (!require("devtools")) install.packages("devtools")
- devtools::install_github("agdamsbo/FreesearchR")
- library(FreesearchR)
- # Load sample data (e.g., mtcars) to make it available in the app
- data(mtcars)
- launch_FreesearchR(INCLUDE_GLOBALENV=TRUE)
- ```
+ require("devtools")
+ devtools::install_github("agdamsbo/FreesearchR")
+ library(FreesearchR)
+ # By loading mtcars to the environment, it will be available
+ # in the interface like any other data.frame
+ data(mtcars)
+ launch_FreesearchR()
-All the variables specified above can also be passed to the app on
-launch from R. Set DATA_LIMIT_UPPER=0 to remove upper data limit. This
-limit is set to protect the online app version from choking and crashing
-on large data sets.
+### Running with docker compose
-### Running with Docker Compose
+For advanced users, wanting to deploy the FreesearchR app to run
+anywhere, a docker image is available.
-For advanced users, you can deploy **FreesearchR** using Docker. A data
-folder can be mounted to `/app/data` to automatically load supported
-file types (`.csv`, `.tsv`, `.txt`, `.xls`, `.xlsx`, `.ods`, `.dta`,
-`.rds`) at startup.
+Below is the minimal `docker_compose.yml` file:
-To mount a local data folder, add a `volumes` entry to your
-`docker-compose.yml` file:
-
-``` yaml
-services:
- shiny:
- image: ghcr.io/agdamsbo/freesearchr:latest
- volumes:
- - ./data:/app/data:ro
- environment:
- - INCLUDE_GLOBALENV=FALSE
- - DATA_LIMIT_DEFAULT=10000
- - DATA_LIMIT_UPPER=100000
- - DATA_LIMIT_LOWER=1
- ports:
- - '3838:3838'
- restart: on-failure
-```
-
-- The `:ro` flag mounts the folder as **read-only**, preventing the app
- from modifying your original data files.
-
-- If no volume is mounted, the app will start without any preloaded
- datasets.
+ services:
+ freesearchr:
+ image: ghcr.io/agdamsbo/freesearchr:latest
+ ports:
+ - '3838:3838'
+ restart: on-failure
## Code of Conduct
diff --git a/news/index.html b/news/index.html
index c2e565cd..bc246f45 100644
--- a/news/index.html
+++ b/news/index.html
@@ -7,7 +7,7 @@
FreesearchR
-
26.3.4
+
26.3.3
FreesearchR 26.3.3
-
NEW option to pass global settings when running as docker or launching from R. Support for INCLUDE_GLOBALENV, DATA_LIMIT_DEFAULT, DATA_LIMIT_UPPER and DATA_LIMIT_LOWER. Described in the README.
-
FIX faster data description function.
-
Also added a few tests to the package.
+
NEW option to pass global settings when running as docker or launching from R. Support for INCLUDE_GLOBALENV, DATA_LIMIT_DEFAULT, DATA_LIMIT_UPPER and DATA_LIMIT_LOWER. Docs are missing…
FreesearchR 26.3.2
diff --git a/news/index.md b/news/index.md
index 1b5ba448..e2b49bac 100644
--- a/news/index.md
+++ b/news/index.md
@@ -1,16 +1,10 @@
# Changelog
-## FreesearchR 26.3.4
-
## FreesearchR 26.3.3
*NEW* option to pass global settings when running as docker or launching
from R. Support for INCLUDE_GLOBALENV, DATA_LIMIT_DEFAULT,
-DATA_LIMIT_UPPER and DATA_LIMIT_LOWER. Described in the README.
-
-*FIX* faster data description function.
-
-Also added a few tests to the package.
+DATA_LIMIT_UPPER and DATA_LIMIT_LOWER. Docs are missing…
## FreesearchR 26.3.2
diff --git a/pkgdown.yml b/pkgdown.yml
index 095b1107..3484db3d 100644
--- a/pkgdown.yml
+++ b/pkgdown.yml
@@ -7,7 +7,7 @@ articles:
missingness: missingness.html
session: session.html
visuals: visuals.html
-last_built: 2026-03-12T13:36Z
+last_built: 2026-03-11T13:00Z
urls:
reference: https://agdamsbo.github.io/FreesearchR/reference
article: https://agdamsbo.github.io/FreesearchR/articles
diff --git a/reference/FreesearchR_palette.html b/reference/FreesearchR_palette.html
index 6c4948a0..7860ba77 100644
--- a/reference/FreesearchR_palette.html
+++ b/reference/FreesearchR_palette.html
@@ -7,7 +7,7 @@
FreesearchR
-
26.3.4
+
26.3.3
diff --git a/reference/getfun.md b/reference/getfun.md
index 64716300..c7dd65f4 100644
--- a/reference/getfun.md
+++ b/reference/getfun.md
@@ -95,6 +95,6 @@ getfun("stats::lm")
#> z$qr <- NULL
#> z
#> }
-#>