rename pkg --> talweg

[talweg.git] / talweg / man / talweg-package.Rd

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