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

Rename to geposanui and update README

Browse source
This commit is contained in:
Elias Projahn 2022-05-20 09:38:26 +02:00
parent 8f6ebc290f
commit f6420eaf3f
3 changed files with 52 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

45
README.md
View file

@ -1,21 +1,56 @@
# tpeold
# geposanui
Tpeold provides a Shiny interface for analyzing genes and finding TPE-OLD
candidates based on known TPE-OLD genes.
This package provides a graphical user interface for analyzing genes based on
position data across species. It is a frontend for the R package
[`geposan`](https://code.johrpan.de/johrpan/geposan). You can visit an example
instance of the application [here](https://tpe-old.uni-rostock.de) where the
method is used to find new
[TPE-OLD](https://www.ncbi.nlm.nih.gov/pmc/articles/PMC4233240/) candidate
genes based on the currently known ones.
## Installation
You can install the development version of tpeold using:
You can install the development version of `geposanui` using:
```r
# install.packages("remotes")
remotes::install_github("dreamRs/shinyvs")
remotes::install_git("https://code.johrpan.de/johrpan/tpeold.git")
remotes::install_git("https://code.johrpan.de/johrpan/geposanui.git")
```
See [this page](https://remotes.r-lib.org/reference/install_git.html) for more
information on this command.
## Usage
The main entry point is the `run_app()` function that is provided by the
package. It will setup the initial analysis and provide the interactive user
interface. You have to provide at least one gene set for the application to
work. The following minimal example shows how to do that:
```r
# Ten random genes from Ensembl.
my_interesting_genes <- c(
"ENSG00000142347",
"ENSG00000186174",
"ENSG00000143553",
"ENSG00000240972",
"ENSG00000105357",
"ENSG00000159251",
"ENSG00000258643",
"ENSG00000147873",
"ENSG00000158270",
"ENSG00000197616"
)
# Choose a name for your gene set.
geposanui::run_app(list("Interesting genes" = my_interesting_genes))
```
This will run the application which you can reach using your favorite browser.
For more information on the options provided by the function, take a look at the
built-in documentation (`?geposanui::run_app`).
## License
This program is free software: you can redistribute it and/or modify it under