max/ourMELONS
1
0
Fork 0
Code Issues 1 Pull requests Projects Releases Packages Wiki Activity Actions

Merge branch 'move-todo-to-issues' into dev

Browse source
This commit is contained in:
Waldir Leoncio 2020-11-09 08:14:51 +01:00
commit f37f0068c6
2 changed files with 1 additions and 25 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
TODO.md → PITFALLS.md
View file

@ -1,27 +1,3 @@
# Roadmap for next stable release
## Minimum requirements
For the first stable release of rBAPS, the following features should be implemented:
- [ ] Clustering of individuals (import `greedyMix.m` from BAPS)
- [ ] Clustering of populations (import `greedyPoPMix.m` from BAPS)
- [ ] Spatial clustering of individuals (import `spatialMixture.m` from BAPS)
- [ ] Spatial clustering of populations (import `spatialPoPMixture.m` from BAPS)
- [x] Admixture analysis (import `admix1.m` from BAPS)
Note to contributors: as tasks get finished (translated, not necessarily tested), please update this file with an `x` and keep it there. This should help us fill out a changelog for an eventual stable release.
## Wishlist
The list below contains non-essential but nice-to-have tasks for the next stable release.
- [ ] Implement sparse matrix optimizations from [`fastbaps`](https://github.com/gtonkinhill/fastbaps)
- [ ] Implement plotting functionality from [`starmie`](https://github.com/sa-lee/starmie)
- [ ] Standardize capitalization of function names
- [ ] Standardize capitalization of function arguments
- [ ] Replace redundant functions (ex.: `randga`)
# Known pitfalls # Known pitfalls
The following behavioral differences have been detected between the Matlab functions and their R counterparts. In order to save time, these differences will not be addressed, since they could require extensive reworking of a function. However, such differences may very well cause unexpected problems in some situations, which is why compiling this list is so important. The tables below might provide a good starting point for identifying and fixing bugs. The following behavioral differences have been detected between the Matlab functions and their R counterparts. In order to save time, these differences will not be addressed, since they could require extensive reworking of a function. However, such differences may very well cause unexpected problems in some situations, which is why compiling this list is so important. The tables below might provide a good starting point for identifying and fixing bugs.

2
README.md
View file

@ -13,7 +13,7 @@ remotes::install_github("ocbe-uio/rBAPS", "dev")
## Contributing ## Contributing
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 todos and pitfalls on the [TODO.md](TODO.md) file. 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.
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). 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).