Improved documentation
This commit is contained in:
parent
1b79529e4b
commit
f9a344ad88
4 changed files with 24 additions and 4 deletions
|
|
@ -2,6 +2,7 @@
|
|||
|
||||
export(admix1)
|
||||
export(calculatePopLogml)
|
||||
export(colon)
|
||||
export(computeIndLogml)
|
||||
export(computeRows)
|
||||
export(etsiParas)
|
||||
|
|
|
|||
5
TODO.md
5
TODO.md
|
|
@ -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.
|
||||
|
||||
- [ ] Uniformize capitalization of function names
|
||||
- [ ] Uniformize capitalization of function arguments
|
||||
- [ ] Standardize capitalization of function names
|
||||
- [ ] Standardize capitalization of function arguments
|
||||
- [ ] Implement optimizations from `fastbaps`
|
||||
- [ ] 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` | `<vector>` | `'<vector elements>'` | `'<vector elements>'` + warning |
|
||||
| `repmat` | `length(n)` | `> 2` | > 2D matrix | 2D matrix |
|
||||
| `computeIndLogml` | some arguments < 0 | complex number | `NaN` |
|
||||
|
||||
As general remarks, one should keep in mind that:
|
||||
|
||||
|
|
|
|||
20
man/etsiParas.Rd
Normal file
20
man/etsiParas.Rd
Normal 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?
|
||||
}
|
||||
|
|
@ -2,7 +2,7 @@
|
|||
% Please edit documentation in R/laskeMuutokset4.R
|
||||
\name{laskeMuutokset4}
|
||||
\alias{laskeMuutokset4}
|
||||
\title{laskeMuutokset4}
|
||||
\title{Calculate changes?}
|
||||
\usage{
|
||||
laskeMuutokset4(osuus, osuusTaulu, omaFreqs, logml, COUNTS = matrix(0))
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue