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{ |
4e25de2c BA |
16 | To start working with this package, use ?computeForecast |
17 | ||
18 | The package R6 is used to abstract data and forecast(er)s implementation from their usage. | |
19 | ||
20 | The package devtools could be useful in development stage, since we rely on testthat for | |
21 | unit tests and roxygen2 for documentation. rainbow package is used for some plots: | |
22 | \code{plotFbox()} and \code{plotFilamentsBox()}. | |
3d69ff21 BA |
23 | } |
24 | ||
25 | \author{ | |
26 | \packageAuthor{talweg} | |
27 | ||
28 | Maintainer: \packageMaintainer{talweg} | |
29 | } | |
30 | ||
31 | %\references{ | |
32 | % TODO: Literature or other references for background information | |
33 | %} |