pkg/man/aggexp-package.Rd

   1 \name{aggexp-package}
   2 \alias{aggexp-package}
   3 \alias{aggexp}
   4 \docType{package}
   5
   6 \title{
   7     \packageTitle{aggexp}
   8 }
   9
  10 \description{
  11     \packageDescription{aggexp}
  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
  18     The main entry point is located in R/z_runAlgorithm.R, and take threee parameters:
  19     \itemize{
  20         \item{the algorithm (short) name,}
  21         \item{the list of stations dataframes,}
  22         \item{the vector of experts names.}
  23     }
  24 }
  25
  26 \author{
  27     \packageAuthor{aggexp}
  28
  29     Maintainer: \packageMaintainer{aggexp}
  30 }
  31
  32 %\references{
  33 %   TODO: Literature or other references for background information
  34 %}
  35
  36 %\examples{
  37 %   TODO: simple examples of the most important functions
  38 %}