From 32f8ac246b2998c39f7d328043a3d685bd3d6b20 Mon Sep 17 00:00:00 2001 From: Waldir Leoncio Date: Mon, 9 Nov 2020 08:13:07 +0100 Subject: [PATCH 1/2] Moved todos to issues page --- README.md | 2 +- TODO.md | 24 ------------------------ 2 files changed, 1 insertion(+), 25 deletions(-) diff --git a/README.md b/README.md index ecae7a9..12da566 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ remotes::install_github("ocbe-uio/rBAPS", "dev") ## 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 [TODO.md](TODO.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). diff --git a/TODO.md b/TODO.md index 355af13..40db8b4 100644 --- a/TODO.md +++ b/TODO.md @@ -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 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. From 23a50b0034054fee4d0abf50fe2f35958cef9fdc Mon Sep 17 00:00:00 2001 From: Waldir Leoncio Date: Mon, 9 Nov 2020 08:13:50 +0100 Subject: [PATCH 2/2] Renamed TODOS to PITFALLS --- TODO.md => PITFALLS.md | 0 README.md | 2 +- 2 files changed, 1 insertion(+), 1 deletion(-) rename TODO.md => PITFALLS.md (100%) diff --git a/TODO.md b/PITFALLS.md similarity index 100% rename from TODO.md rename to PITFALLS.md diff --git a/README.md b/README.md index 12da566..3fce3d2 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ remotes::install_github("ocbe-uio/rBAPS", "dev") ## 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 tasks we're working on for the first release of rBAPS [here](https://github.com/ocbe-uio/rBAPS/milestone/1). 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).