use roxygen2 for automatic documentation

walke · Sep 24, 2019 · 3127120 · 3127120
1 parent abbef4c
commit 3127120
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 0 deletions.
diff --git 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
@@ -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
@@ -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