Updated documentation

README.md

@@ -15,6 +15,8 @@ remotes::install_github("ocbe-uio/rBAPS", "dev")
 
 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.
 
+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
 
 ### How to cite this project

TODO.md

@@ -32,7 +32,7 @@ As general remarks, one should keep in mind that:
 - Some clobal variables have been added as a new (last) argument to the function they appear in.
 - When a function is defined on Matlab with multiple outputs, as in `[y1, y2] = f(x)`, it will output only `y1` if called without assignment, as in `f(3)`, or if called with a one-length assignment, as in `a = f(3)`. In order to receive the full output, one must assign two variables to the left side of the assignment operator, as in `[a, b] = f(3)`. rBAPS Functions that might be affected by this behavior include `etsiParas`.
 
-## Functional differences in rBAPS functions
+## Some functional differences in rBAPS functions
 
 | Function          | Argument           | Value          | Matlab output         | R output                        |
 | ----------------- | ------------------ | -------------- | --------------------- | ------------------------------- |
@@ -40,8 +40,12 @@ As general remarks, one should keep in mind that:
 | `ownNum2Str`      | `number`           | `<vector>`     | `'<vector elements>'` | `'<vector elements>'` + warning |
 | `repmat`          | `length(n)`        | `> 2`          | > 2D matrix           | 2D matrix                       |
 
-## Functional differences in base Matlab functions
+## Some functional differences in base Matlab functions
 
 Function | Matlab output | R output
 -------- | ------------- | --------
-`max` | Can handle complex numbers | Cannot handle complex numbers
+`max` | Can handle complex numbers | Cannot handle complex numbers
+
+# Wanna help debugging?
+
+If you find an error, one of the first things to try is to compare the R code with its MATLAB equivalent, which you can find [here](matlab).

man/rivinSisaltamienMjonojenLkm.Rd

@@ -13,5 +13,5 @@ rivinSisaltamienMjonojenLkm(line)
 count
 }
 \description{
-Number of M queues
+Returns the number of queues contained in the line. There must be a space between the queues.
 }

man/testaaGenePopData.Rd

@@ -9,6 +9,12 @@ testaaGenePopData(tiedostonNimi)
 \arguments{
 \item{tiedostonNimi}{Filename}
 }
+\value{
+kunnossa (binary "ok" condition value) == 0 if the data is not valid genePop data. Otherwise, kunnossa == 1.
+}
 \description{
 Tests GenePop data
 }
+\details{
+GenePop data are textfiles that follow the GenePop format. This function checks if such file is properly formatted as GenePop.
+}

man/testaaPop.Rd

@@ -10,7 +10,7 @@ testaaPop(rivi)
 \item{rivi}{Line}
 }
 \value{
-pal
+pal = 1 if the line starts with one of the following
 }
 \description{
 Test a line in the population