From 12efc84437a8c5f66ac8d2c6db926c6c020a3697 Mon Sep 17 00:00:00 2001 From: Waldir Leoncio Date: Mon, 16 Dec 2019 17:47:25 +0100 Subject: [PATCH] Improved README and TODO --- README.md | 4 ++++ TODO.md | 13 +++++++++++++ 2 files changed, 17 insertions(+) diff --git a/README.md b/README.md index 3f4c095..eadc557 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,10 @@ rBAPS is currently under development and a stable version is yet to be released. 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. + ## References ### Scientific papers diff --git a/TODO.md b/TODO.md index 6870710..9c64ccd 100644 --- a/TODO.md +++ b/TODO.md @@ -1,3 +1,5 @@ +# Minimum requirements for next stable release + For the first stable release of rBAPS, the following features should be implemented: - [ ] Clustering of populations (import `greedyPoPMix.m` from BAPS) @@ -7,3 +9,14 @@ For the first stable release of rBAPS, the following features should be implemen - [ ] Admixture analysis (import `admix1.m` from BAPS) Note to contributors: as tasks get finished, please update this file with an `x` and keep it there. This should help us fill out a changelog for an eventual stable release. + +# 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 list below might provide a good starting point for identifying and fixing bugs: + +## `ownNum2Str` + +Argument | Value | Matlab output | R output +---------|-------|---------------|--------- +`number` | `'NaN` | `'NAN'` | error +`number` | `` | `''` | `''` + warning \ No newline at end of file