Commit | Line | Data |
---|---|---|
cbd88fe5 BA |
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 | Concerning the other suggested packages: | |
18 | \itemize{ | |
19 | \item{tensor is used for comparing to some reference functions initially coded in R; | |
20 | it should not be required in further package versions;} | |
21 | \item{jointDiag allows to solve a joint diagonalization problem, providing a more | |
22 | robust solution compared to a single diagonalization;} | |
23 | \item{parallel (generally) permits to run the bootstrap method faster.} | |
24 | } | |
25 | ||
26 | The three main functions are located in R/main.R: | |
27 | \itemize{ | |
28 | \item{getParamsDirs_ref: reference method to estimate parameters directions;} | |
29 | \item{getParamsDirs: method of choice to estimate parameters directions, using a | |
30 | spectral decomposition of inputs/outputs;} | |
31 | \item{getBootstrapParams: run getParamsDirs on B bootstrap replicates.} | |
32 | } | |
33 | } | |
34 | ||
35 | \author{ | |
36 | \packageAuthor{morpheus} | |
37 | ||
38 | Maintainer: \packageMaintainer{morpheus} | |
39 | } | |
40 | ||
41 | %\references{ | |
42 | % TODO: Literature or other references for background information | |
43 | %} | |
44 | ||
45 | %\examples{ | |
46 | % TODO: simple examples of the most important functions | |
47 | %} |