\packageDescription{talweg}
}
+%TODO: better details
\details{
- The package devtools should be useful in development stage, since we rely on testthat for
- unit tests, and roxygen2 for documentation. knitr is used to generate the package vignette.
- Concerning the other suggested packages:
- \itemize{
- \item{TODO...;}
- \item{TODO...;}
- }
-
- The three main functions are located in R/main.R:
- \itemize{
- \item{TODO...;}
- \item{TODO...;}
- }
+ To start working with this package, use ?computeForecast.
+ Plotting methods are all in 'seealso' section of ?plotError.
+
+ The package R6 is used to abstract data and forecast(er)s implementation from their usage.
+
+ The package devtools could be useful in development stage, since we rely on testthat for
+ unit tests and roxygen2 for documentation. rainbow package is used for some plots:
+ \code{plotFbox()} and \code{plotFilamentsBox()}.
}
\author{
%\references{
% TODO: Literature or other references for background information
%}
-
-%\examples{
-% TODO: simple examples of the most important functions
-%}