From 31271207b6d54082dc0cfe6534cccc87fca11a7e Mon Sep 17 00:00:00 2001 From: Rainer Walke Date: Tue, 24 Sep 2019 13:52:19 +0200 Subject: [PATCH] use roxygen2 for automatic documentation --- DESCRIPTION | 1 + R/HMDClasses.R | 7 +++++++ eoR.Rproj | 1 + man/LT1-class.Rd | 15 +++++++++++++++ 4 files changed, 24 insertions(+) create mode 100644 man/LT1-class.Rd diff --git a/DESCRIPTION b/DESCRIPTION index 300753d..05af8b4 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -11,3 +11,4 @@ Encoding: UTF-8 Depends: R (>= 3.2.0) Imports: methods, data.table LazyData: no +RoxygenNote: 6.1.1 diff --git a/R/HMDClasses.R b/R/HMDClasses.R index cd25c73..721e0a5 100644 --- a/R/HMDClasses.R +++ b/R/HMDClasses.R @@ -7,6 +7,13 @@ require(data.table) # S4 class definitions # class for life-tables 1x1 + + +#' LT1 Class +#' +#' A \code{LT1} is used to .. +#' +#' @slot header1 The LT1 setClass("LT1", slots=c( header1="vector", # file header diff --git a/eoR.Rproj b/eoR.Rproj index 398aa14..88ff2b5 100644 --- a/eoR.Rproj +++ b/eoR.Rproj @@ -18,3 +18,4 @@ StripTrailingWhitespace: Yes BuildType: Package PackageUseDevtools: Yes PackageInstallArgs: --no-multiarch --with-keep.source +PackageRoxygenize: rd,collate,namespace diff --git a/man/LT1-class.Rd b/man/LT1-class.Rd new file mode 100644 index 0000000..bcc9daa --- /dev/null +++ b/man/LT1-class.Rd @@ -0,0 +1,15 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/HMDClasses.R +\docType{class} +\name{LT1-class} +\alias{LT1-class} +\title{LT1 Class} +\description{ +A \code{LT1} is used to .. +} +\section{Slots}{ + +\describe{ +\item{\code{header1}}{The LT1} +}} +