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

Added CHANGELOG, improved other docs

Browse source
This commit is contained in:
Waldir Leoncio 2019-12-16 18:42:50 +01:00
parent 1cb703c2d3
commit 680739bccc
3 changed files with 14 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
CHANGELOG.md Normal file
View file

@ -0,0 +1,3 @@
# Changelog
(no stable releases have been published yet)

1
R/ownNum2Str.R
View file

@ -1,4 +1,5 @@
#' @title Own number to string #' @title Own number to string
#' @description Converts numbers to strings
#' @param number number #' @param number number
#' @note On Matlab, if number is NaN the output is 'NaN'. Here, the output will be an error. Also, the function belo expects "number" to have length one, whereas Matlab accepts vectors. #' @note On Matlab, if number is NaN the output is 'NaN'. Here, the output will be an error. Also, the function belo expects "number" to have length one, whereas Matlab accepts vectors.
#' @export #' @export

11
TODO.md
View file

@ -1,4 +1,6 @@
# Minimum requirements for next stable release # Roadmap for next stable release
## Minimum requirements
For the first stable release of rBAPS, the following features should be implemented: For the first stable release of rBAPS, the following features should be implemented:
@ -10,6 +12,13 @@ For the first stable release of rBAPS, the following features should be implemen
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. 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.
## Wishlist
The list below contains non-essential but nice-to-have tasks for the next stable release.
- [ ] Uniformize capitalization of function names
- [ ] Uniformize capitalization of function arguments
# 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 list 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 list below might provide a good starting point for identifying and fixing bugs: