adding package help page

mittelmark · Sep 6, 2023 · 16efb06 · 16efb06
1 parent 8d65781
commit 16efb06
Show file tree

Hide file tree

Showing 3 changed files with 47 additions and 1 deletion.
diff --git a/Makefile b/Makefile
@@ -8,3 +8,6 @@ check: build
 
 man/%.Rd: R/%.R
 	Rscript bin/rman.R $<
+
+install: check
+	R CMD INSTALL $(PKG)_$(VERSION).tar.gz
diff --git a/R/add.R b/R/add.R
@@ -7,7 +7,30 @@
 ## > source('bin/rman.R')
 ## > extractRd(list.files("R",pattern="*.R$",full.names=TRUE))
 
-## Function documentation, protect percent signs % with backslashes \%
+## package-documentation
+#' \name{Rpkg-package}
+#' \alias{Rpkg-package}
+#' \title{Rpkg package - package template for R packages}
+#' \description{The Rpkg package can be used as a template to create new packages from scratch.}
+#' \details{Some more details:
+#' The following list of objects and/or functions are available:
+#' \describe{
+#' \item{\link[Rpkg:add]{add(x,y)}}{an illustrative add function}
+#' }
+#' }
+#' \examples{
+#' library(Rpkg)
+#' add(1,2)
+#' }
+#' \author{Detlef Groth <dgroth@uni-potsdam.de>}
+#' \references{
+#' \itemize{
+#'    \item XYZ 
+#' }
+#' }
+""
+
+## Functions documentation, protect percent signs % with backslashes \%
 
 #' \name{add}
 #' \alias{add}

diff --git a/man/Rpkg-package.Rd b/man/Rpkg-package.Rd
@@ -0,0 +1,20 @@
+\name{Rpkg-package} 
+\alias{Rpkg-package} 
+\title{Rpkg package - package template for R packages} 
+\description{The Rpkg package can be used as a template to create new packages from scratch.} 
+\details{Some more details: 
+The following list of objects and/or functions is available: 
+\describe{ 
+\item{\link[Rpkg:add]{add(x,y)}}{an illustrative add function} 
+} 
+} 
+\examples{ 
+library(Rpkg) 
+add(1,2) 
+} 
+\author{Detlef Groth <dgroth@uni-potsdam.de>} 
+\references{ 
+\itemize{ 
+   \item XYZ  
+} 
+}