Add README

This commit is contained in:
Elias Projahn 2021-10-19 13:47:33 +02:00
parent c52d42c2b6
commit 16e83d38a8

29
README.md Normal file
View file

@ -0,0 +1,29 @@
# geposan
Geposan is a R package for analyzing genes based on their position across
species. The package includes gene data from Ensembl. It provides multiple
methods to use that data to find genes that score well in comparison with a
set of reference genes.
## Installation
You can install the development version of geposan from
[GitHub](https://github.com/) with:
```r
# install.packages("devtools")
devtools::install_github("johrpan/geposan")
```
## License
This program is free software: you can redistribute it and/or modify it under
the terms of the GNU 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 General Public License](https://www.gnu.org/licenses/gpl-3.0) for more
details.