ourMELONS/README.md

47 lines
3.2 KiB
Markdown
Raw Normal View History

2021-09-03 09:56:46 +02:00
[![](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
[![](https://img.shields.io/github/last-commit/ocbe-uio/rBAPS.svg)](https://github.com/ocbe-uio/rBAPS/commits/master)
[![R build status](https://github.com/ocbe-uio/rBAPS/workflows/R-CMD-check/badge.svg)](https://github.com/ocbe-uio/rBAPS/actions)
2021-09-03 09:56:46 +02:00
[![](https://img.shields.io/github/languages/code-size/ocbe-uio/rBAPS.svg)](https://github.com/ocbe-uio/rBAPS)
2020-03-02 16:10:29 +01:00
2019-12-12 13:34:58 +01:00
# rBAPS
R implementation of the compiled Matlab BAPS software for Bayesian Analysis of Population Structure.
## Installation
rBAPS is currently under development and a stable version is yet to be released. You can install the development version by issuing the command below on an interactive R session.
2020-11-09 07:38:42 +01:00
```r
2021-06-25 07:49:47 +02:00
remotes::install_github("ocbe-uio/rBAPS", "develop")
```
At the current stage, we still recommend using the original BAPS software for production.
2019-12-16 17:47:25 +01:00
## Contributing
2020-11-09 08:13:50 +01:00
rBAPS is Open Software licenced under the [GPL-3](https://tldrlegal.com/license/gnu-general-public-license-v3-(gpl-3)), so all contributions are welcome. You can find a list of tasks we're working on for the first release of rBAPS [here](https://github.com/ocbe-uio/rBAPS/milestone/1). and pitfalls on the [PITFALLS.md](PITFALLS.md) file.
2019-12-16 17:47:25 +01:00
2020-10-19 14:38:27 +02:00
Found something not to be working as you think it should? Please help us by [opening an issue](https://github.com/ocbe-uio/rBAPS/issues/new).
## References
2020-01-14 11:29:42 +01:00
### How to cite this project
2020-01-15 17:27:32 +01:00
After installing the package, issue `citation("rBAPS")` in R. You will get a pure text and a BibTeX entry of rBAPS. Alternatively, you can use the [CITATION.cff](CITATION.cff) file, which conforms to the [Citation File Format](https://citation-file-format.github.io/) standard.
2020-01-14 11:29:42 +01:00
### Scientific papers
2020-01-14 11:29:42 +01:00
These are some of the scientific publications that served as base for the creation of rBAPS:
- Corander, J. and Marttinen, P. (2006), Bayesian identification of admixture events using multilocus molecular markers. Molecular Ecology, 15: 2833-2843. doi:[10.1111/j.1365-294X.2006.02994.x](https://doi.org/10.1111/j.1365-294X.2006.02994.x)
- Corander, J., Sirén, J., & Arjas, E. (2008). Bayesian spatial modeling of genetic population structure. Computational Statistics, 23(1), 111-129. doi:[10.1007/s00180-007-0072-x](https://link.springer.com/content/pdf/10.1007/s00180-007-0072-x.pdf)
- Corander, J., Marttinen, P., Sirén, J. et al. Enhanced Bayesian modelling in BAPS software for learning genetic structures of populations. BMC Bioinformatics 9, 539 (2008) doi:[10.1186/1471-2105-9-539](https://doi.org/10.1186/1471-2105-9-539)
- Tonkin-Hill G, Lees JA, Bentley SD et al. RhierBAPS: An R implementation of the population clustering algorithm hierBAPS [version 1; peer review: 2 approved]. Wellcome Open Res 2018, 3:93 (https://doi.org/10.12688/wellcomeopenres.14694.1)
### Software
2020-01-14 11:29:42 +01:00
Below we list some of the software directly related to rBAPS:
- [Original BAPS software](http://www.helsinki.fi/bsg/software/BAPS/)
- [RhierBAPS: An R implementation of the population clustering algorithm hierBAPS](https://github.com/gtonkinhill/rhierbaps)
2020-11-09 07:38:42 +01:00
- [fastbaps: A fast genetic clustering algorithm that approximates a Dirichlet Process Mixture model](https://github.com/gtonkinhill/fastbaps)