Improved documentation

This commit is contained in:
Waldir Leoncio 2020-01-15 15:30:22 +01:00
parent 1b79529e4b
commit f9a344ad88
4 changed files with 24 additions and 4 deletions

View file

@ -2,6 +2,7 @@
export(admix1) export(admix1)
export(calculatePopLogml) export(calculatePopLogml)
export(colon)
export(computeIndLogml) export(computeIndLogml)
export(computeRows) export(computeRows)
export(etsiParas) export(etsiParas)

View file

@ -16,8 +16,8 @@ Note to contributors: as tasks get finished, please update this file with an `x`
The list below contains non-essential but nice-to-have tasks for the next stable release. The list below contains non-essential but nice-to-have tasks for the next stable release.
- [ ] Uniformize capitalization of function names - [ ] Standardize capitalization of function names
- [ ] Uniformize capitalization of function arguments - [ ] Standardize capitalization of function arguments
- [ ] Implement optimizations from `fastbaps` - [ ] Implement optimizations from `fastbaps`
- [ ] Replace redundant functions (ex.: `randga`) - [ ] Replace redundant functions (ex.: `randga`)
@ -30,7 +30,6 @@ The following behavioral differences have been detected between the Matlab funct
| `ownNum2Str` | `number` | `NaN` | `'NAN'` | error | | `ownNum2Str` | `number` | `NaN` | `'NAN'` | error |
| `ownNum2Str` | `number` | `<vector>` | `'<vector elements>'` | `'<vector elements>'` + warning | | `ownNum2Str` | `number` | `<vector>` | `'<vector elements>'` | `'<vector elements>'` + warning |
| `repmat` | `length(n)` | `> 2` | > 2D matrix | 2D matrix | | `repmat` | `length(n)` | `> 2` | > 2D matrix | 2D matrix |
| `computeIndLogml` | some arguments < 0 | complex number | `NaN` |
As general remarks, one should keep in mind that: As general remarks, one should keep in mind that:

20
man/etsiParas.Rd Normal file
View file

@ -0,0 +1,20 @@
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/etsiParas.R
\name{etsiParas}
\alias{etsiParas}
\title{Etsi Paras}
\usage{
etsiParas(osuus, osuusTaulu, omaFreqs, logml)
}
\arguments{
\item{osuus}{Percentages?}
\item{osuusTaulu}{Percentage table?}
\item{omaFreqs}{own Freqs?}
\item{logml}{log maximum likelihood}
}
\description{
Search for the best?
}

View file

@ -2,7 +2,7 @@
% Please edit documentation in R/laskeMuutokset4.R % Please edit documentation in R/laskeMuutokset4.R
\name{laskeMuutokset4} \name{laskeMuutokset4}
\alias{laskeMuutokset4} \alias{laskeMuutokset4}
\title{laskeMuutokset4} \title{Calculate changes?}
\usage{ \usage{
laskeMuutokset4(osuus, osuusTaulu, omaFreqs, logml, COUNTS = matrix(0)) laskeMuutokset4(osuus, osuusTaulu, omaFreqs, logml, COUNTS = matrix(0))
} }