The GNExT Shiny App provides a graphical user interface for configuring and launching the GNExT Nextflow preprocessing pipeline and preparing the GNExT web platform for deployment.
The application simplifies the configuration of GWAS preprocessing and platform deployment by providing a unified interface for managing input files, computational parameters, and execution settings.
Two installation options are available: Docker or Conda.
Download the Docker image:
docker pull ghcr.io/dyhealthnet/gnext_config_interface:latestStart the Shiny application:
docker run --rm -p 3838:3838 ghcr.io/dyhealthnet/gnext_config_interface:latestNote: The Docker container must have access to the required input/output directories, the GNExT repositories, and the SLURM environment used to submit Nextflow jobs. Configure the appropriate volume mounts and permissions for your system.
If the application is running on a remote server or HPC cluster, create an SSH tunnel from your local computer:
ssh -N -L 3838:localhost:3838 username@serverThen open the following address in your browser:
Keep the SSH connection active while using the application.
Clone the repository and create the environment:
git clone https://github.com/DyHealthNet/gnext_config_interface
cd gnext_config_interface
conda env create -f environment.ymlTip: use mamba instead of conda for faster installation:
mamba env create -f environment.ymlOpen run.sh and edit the SLURM directives to match your cluster:
#SBATCH --partition=YOUR_PARTITION
#SBATCH --nodelist=YOUR_NODEReplace YOUR_PARTITION and YOUR_NODE with the partition and node available on your system.
sbatch run.shOnce the app is running, open an SSH tunnel from your local computer to the cluster node:
ssh -N -L 3838:localhost:3838 username@serverThen open the following address in your browser:
Keep the SSH connection active while using the application.
In the GNExT nf pipeline tab:
- Specify the required input and output paths.
- Load or create the phenotype metadata table.
- Configure study-specific parameters.
- Set computational resources and SLURM parameters.
- Generate the Nextflow configuration files and launch the pipeline.
The preprocessing workflow is submitted to SLURM and generates the files required by the GNExT web platform.
After successful completion of the preprocessing pipeline:
- Open the GNExT platform tab.
- Specify the GNExT platform repository and deployment directories.
- Configure the platform environment variables.
- Point the platform to the generated phenotype metadata and Nextflow results (
JOB_DIR/nf_output/). - Generate the
.envfile and Docker launch script. - Execute the generated launch script to start the GNExT web platform.
If the frontend is running on a remote server, create an SSH tunnel to the frontend port:
ssh -N -L 8080:localhost:<frontend-port> username@serverReplace <frontend-port> with the actual port exposed by the GNExT frontend.
Then open:
Docker option:
- Docker and Docker Compose
- Access to a SLURM-enabled computational environment
- Nextflow and Java available in the execution environment
- GNExT Nextflow pipeline and GNExT platform repositories
Conda option:
- Conda or Mamba
- Access to a SLURM-enabled computational environment
- Nextflow and Java available in the execution environment
- GNExT Nextflow pipeline and GNExT platform repositories
For additional information, see: