@@ -32,14 +32,14 @@ of detected and regulated genes within a specific category\
3232• Process log system for user sessions, useful for checking data
3333processing outcomes, debugging, and analyzing app functionality
3434
35- ## ** The application is available in the cloud or can be installed locally:**
35+ ## ** The application is available in the cloud or can be easily installed locally or on private server container :**
3636
3737### ** Vivid Volcano live at POSIT Connect Cloud**
3838
3939[ ** Vivid volcano cloud
4040version** ] ( https://datviser-vivid-volcano.share.connect.posit.cloud/ )
4141
42- ** Data Privacy Notice** \
42+ ** Data Privacy Notice for the version deployed in the public cloud: ** \
4343When you use this cloud-based application, your data is processed
4444securely within your own session. What it means :
4545
@@ -66,7 +66,7 @@ peer review from the scientific community.**
6666[ ** Vivid volcano features- demo
6767movie** ] ( https://drive.google.com/file/d/1b7IzoJnTdTEW1VTk-L8TeDV9CMX0qKEz/view?usp=drive_link )
6868
69- ### Instructions for running the app locally:
69+ ### Instructions for running the app locally or installing inside a container on the private server :
7070
7171Vivid Volcano uses ** renv** (R environment management) to ensure
7272reproducible package dependencies across different systems. This creates
@@ -77,11 +77,17 @@ an isolated R environment with the exact package versions specified in
7777
78781 . Automated installation
7979
80- Download the [ automated installation
81- script] ( https://drive.google.com/file/d/17_YcYaYWQfYlosE_dQLDN2_PFcA1F2HB/view?usp=sharing )
82- written in bash - it that handles system dependencies, renv setup,
80+ Download the ** automated installation script** written in bash :
81+
82+ ``` bash
83+ # Download the installation script
84+ curl -fsSL -o install_vivid_volcano.sh https://raw.githubusercontent.com/DatViseR/Vivid-Volcano/master/install_vivid_volcano.sh
85+ ```
86+
87+ \- This script that handles optional system dependencies, renv setup,
8388cloning the repository and should enable working with Vivid Volcano
84- locally or in cloud container with just few clicks.
89+ locally or in linux based cloud container with just few clicks. The full
90+ installation may take around 5 min.
8591
8692``` bash
8793# Run the automated installer in the bash terminal
@@ -93,20 +99,18 @@ chmod +x install_vivid_volcano.sh
9399
94100- Checks prerequisites (R 4.4+, Git, system dependencies)
95101
96- - Offers selective installation of system libraries (SSL, cURL, Cairo,
97- etc. )
102+ - Offers selective installation of optional system libraries(such as
103+ Cairo that enhances graphical outputs )
98104
99105- Sets up renv environment with core packages
100106
101- - Excludes problematic packages (PostgreSQL, V8) for stability
102-
103107- If users accepts run the app in the browser
104108
105- Next time if you want to run the app from the unix terminal, you have
106- several options:
109+ Next time if you want to run the app from the UNIX terminal, you have
110+ two options:
107111
108112``` bash
109- # Make sure you are in Vivid-Volcano folder
113+ # Make sure you are in Vivid-Volcano folder (cd Vivid-Volcano)
110114
111115# Enhanced launcher (recommended for macOS)
112116./launch_app.sh
@@ -131,7 +135,7 @@ Volcano locally
131135git clone https://github.com/DatViseR/Vivid-Volcano.git
132136cd Vivid-Volcano
133137
134- # Install system dependencies (Ubuntu/Debian example)
138+ # Install system dependencies (Ubuntu/Debian example) - OPTIONAL for enhance feuteres and developers who wish to modify the app (enabling pdf gt tables output)
135139sudo apt-get update
136140sudo apt-get install libssl-dev libcurl4-openssl-dev libxml2-dev
137141
@@ -180,12 +184,31 @@ renv::activate()
180184renv :: restore()
181185```
182186
183- 4 . Handle Potential Issues If package installation fails:
187+ 4 . Handle Potential Issues If renv package installation fails - install
188+ essential core packages from CRAN repository:
184189
185190``` r
186- # Skip problematic packages and install core ones
187- core_packages <- c(" shiny" , " dplyr" , " ggplot2" , " DT" , " ggtext" ,
188- " ggrepel" , " shiny.semantic" , " arrow" )
191+
192+ core_packages <- c(
193+ " shiny" , # Core web application framework
194+ " shinyjs" , # JavaScript integration for Shiny
195+ " shinyalert" , # Modal alerts in Shiny
196+ " shiny.semantic" , # Semantic UI theming
197+ " semantic.dashboard" ,# Semantic UI dashboards
198+ " dplyr" , # Data manipulation
199+ " tidyr" , # Data tidying
200+ " data.table" , # High-performance data manipulation
201+ " readr" , # Fast data import
202+ " arrow" , # Parquet/Feather file support
203+ " ggplot2" , # Core plotting
204+ " ggrepel" , # Better text labels in ggplot2
205+ " ggtext" , # Rich text in ggplot2
206+ " DT" , # Interactive tables
207+ " gt" , # Modern HTML tables
208+ " plotly" , # Interactive plots
209+ " colourpicker" , # Flexible color pickers
210+ " gridExtra" # Arrange multiple grid-based plots
211+ )
189212install.packages(core_packages )
190213```
191214
0 commit comments