ubigen/README.md

42 lines
1.3 KiB
Markdown
Raw Normal View History

2022-06-02 19:30:31 +02:00
# Ubigen
This R package contains precomputed data including comparisons in gene
expression within the [GTEx database](https://gtexportal.org). It provides a
graphical interface to analyze and visualize those data to rank genes based on
how ubiquitously expressed they are.
## Installation
You can install the development version of `ubigen` using:
```r
# install.packages("remotes")
2025-03-04 19:56:52 +01:00
remotes::install_git("https://github.com/johrpan/ubigen.git")
2022-06-02 19:30:31 +02:00
```
## 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.
```r
ubigen::run_app()
```
For additional information, take a look at the built-in documentation
(`?ubigen::run_app`).
## 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
2022-06-22 11:11:03 +00:00
[GNU Affero General Public License](https://www.gnu.org/licenses/agpl-3.0.html)
2022-06-02 19:30:31 +02:00
for more details.