X-Git-Url: https://git.auder.net/?a=blobdiff_plain;f=aggexp%2Fman%2Faggexp-package.Rd;fp=aggexp%2Fman%2Faggexp-package.Rd;h=e531d7c001c3112944d05fa0ffb46ceb90f60c1b;hb=57dbbab63a48b42f85e0a711640e1dd10b58f18a;hp=0000000000000000000000000000000000000000;hpb=357b8be00388d07c04c10d4bf7f503fd947185d2;p=aggexp.git

diff --git a/aggexp/man/aggexp-package.Rd b/aggexp/man/aggexp-package.Rd
new file mode 100644
index 0000000..e531d7c
--- /dev/null
+++ b/aggexp/man/aggexp-package.Rd
@@ -0,0 +1,42 @@
+\name{aggexp-package}
+\alias{aggexp-package}
+\alias{aggexp}
+\docType{package}
+
+\title{
+	\packageTitle{aggexp}
+}
+
+\description{
+	\packageDescription{aggexp}
+}
+
+\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...;}
+	}
+}
+
+\author{
+	\packageAuthor{aggexp}
+
+	Maintainer: \packageMaintainer{aggexp}
+}
+
+%\references{
+%	TODO: Literature or other references for background information
+%}
+
+%\examples{
+%	TODO: simple examples of the most important functions
+%}