From: Benjamin Auder Date: Sun, 12 Feb 2017 22:34:00 +0000 (+0100) Subject: add package-valse.Rd in man X-Git-Url: https://git.auder.net/%7B%7B%20asset%28%27mixstore/images/css/img/current/index.css?a=commitdiff_plain;h=c366645be35213c98df336216864543d171fdb93;p=valse.git add package-valse.Rd in man --- diff --git a/.gitignore b/.gitignore index f0abc36..b1cd49c 100644 --- a/.gitignore +++ b/.gitignore @@ -3,5 +3,5 @@ .RData *.swp *~ -/man/ +/man/* !/man/*-package.Rd diff --git a/man/valse-package.Rd b/man/valse-package.Rd new file mode 100644 index 0000000..534375b --- /dev/null +++ b/man/valse-package.Rd @@ -0,0 +1,37 @@ +\name{valse-package} +\alias{valse-package} +\alias{valse} +\docType{package} + +\title{ + \packageTitle{valse} +} + +\description{ + \packageDescription{valse} +} + +\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{parallel (generally) permits to run the bootstrap method faster.} + } + + The three main functions are ... +} + +\author{ + \packageAuthor{valse} + + Maintainer: \packageMaintainer{valse} +} + +%\references{ +% TODO: Literature or other references for background information +%} + +%\examples{ +% TODO: simple examples of the most important functions +%}