projects / talweg.git / blame
| Commit | Line | Data |
|---|---|---|
| 3d69ff21 BA |
1 | \name{talweg-package} |
| 2 | \alias{talweg-package} | |
| 3 | \alias{talweg} | |
| 4 | \docType{package} | |
| 5 | ||
| 6 | \title{ | |
| 7 | \packageTitle{talweg} | |
| 8 | } | |
| 9 | ||
| 10 | \description{ | |
| 11 | \packageDescription{talweg} | |
| 12 | } | |
| 13 | ||
| 4e25de2c | 14 | %TODO: better details |
| 3d69ff21 | 15 | \details{ |
| 1d9b97f8 BA |
16 | To start working with this package, use ?computeForecast. |
| 17 | Plotting methods are all in 'seealso' section of ?plotError. | |
| 4e25de2c BA |
18 | |
| 19 | The package R6 is used to abstract data and forecast(er)s implementation from their usage. | |
| 20 | ||
| 21 | The package devtools could be useful in development stage, since we rely on testthat for | |
| 22 | unit tests and roxygen2 for documentation. rainbow package is used for some plots: | |
| 23 | \code{plotFbox()} and \code{plotFilamentsBox()}. | |
| 3d69ff21 BA |
24 | } |
| 25 | ||
| 26 | \author{ | |
| 27 | \packageAuthor{talweg} | |
| 28 | ||
| 29 | Maintainer: \packageMaintainer{talweg} | |
| 30 | } | |
| 31 | ||
| 32 | %\references{ | |
| 33 | % TODO: Literature or other references for background information | |
| 34 | %} |