Simplify data sampling + cosmetics + draft unit test for W matrix in optim
[morpheus.git] / pkg / man / morpheus-package.Rd
1 \name{morpheus-package}
2 \alias{morpheus-package}
3 \alias{morpheus}
4 \docType{package}
5
6 \title{
7 \packageTitle{morpheus}
8 }
9
10 \description{
11 \packageDescription{morpheus}
12 }
13
14 \details{
15 The package devtools should be useful in development stage, since we rely on testthat for
16 unit tests, and roxygen2 for documentation. knitr is used to generate the package vignette.
17 jointDiag allows to solve a joint diagonalization problem, providing a more robust
18 solution compared to a single diagonalization.
19 Concerning the other suggested packages:
20 \itemize{
21 \item{tensor is used for comparing to some reference functions initially coded in R;
22 it should not be required in further package versions;}
23 \item{parallel (generally) permits to run the bootstrap method faster.}
24 }
25
26 The two main functions are located in R/computeMu.R and R/optimParams.R:
27 \itemize{
28 \item{computeMu(): estimation of parameters directions;}
29 \item{optimParams(): builds an object \code{o} to estimate all other parameters
30 when calling \code{o$run()}, starting from the directions obtained by previous function}
31 }
32 See also \code{multiRun()}, which is a flexible method to run Monte-Carlo or bootstrap
33 estimations using different models in various contexts.
34 }
35
36 \author{
37 \packageAuthor{morpheus}
38
39 Maintainer: \packageMaintainer{morpheus}
40 }
41
42 %\references{
43 % TODO: Literature or other references for background information
44 %}
45
46 %\examples{
47 % TODO: simple examples of the most important functions
48 %}