ubigen/README.md
2025-03-05 17:22:57 +01:00

1.6 KiB

Ubigen

Ubigen is an interactive web application for analyzing ubiquitously expressed genes. It is publicly available at ubigen.uni-rostock.de. This repository contains an R package including the input data, the methods and the code for the interactive web interface.

Installation and Usage

Local

You can install the development version of ubigen using:

# install.packages("pak")
pak::pkg_install("git::https://gitlab.uni-rostock.de/ep135/ubigen.git")

You only need one function to get started. It will run the application and serve the graphical user interface which can be viewed using your preferred web browser:

ubigen::run_app()

For additional information on using the R package, take a look at the built-in documentation (?ubigen::run_app).

Server

Docker images for deploying Ubigen on a server are available on Docker Hub at johrpan/ubigen. They expose the web application at port 3464. We recommend setting up a reverse proxy to enable TLS.

License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.