johrpan/ubigen
1
0
Fork 0
mirror of https://github.com/johrpan/ubigen.git synced 2025-10-26 19:57:24 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add Dockerfile

Browse source
This commit is contained in:
Elias Projahn 2025-03-05 17:22:57 +01:00
parent 753beeed71
commit 5b5c641a47
6 changed files with 37 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -6,7 +6,9 @@ genes. It is publicly available at
This repository contains an R package including the input data, the methods and
the code for the interactive web interface.
## Installation
## Installation and Usage
### Local
You can install the development version of `ubigen` using:
@ -15,11 +17,9 @@ You can install the development version of `ubigen` using:
pak::pkg_install("johrpan/ubigen")
```
## Usage
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.
web browser:
```r
ubigen::run_app()
@ -28,6 +28,12 @@ ubigen::run_app()
For additional information on using the R package, take a look at the built-in
documentation (`?ubigen::run_app`).
### Server
The [`Dockerfile`](Dockerfile) included in this repository can be used to
deploy Ubigen on a server. It exposes 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