improve documentation

get rid of hello.R

NAMESPACE

@@ -5,7 +5,6 @@ export(Exposure1)
 export(LTable1)
 export(RegDeath1)
 export(RegExp1)
-export(hello)
 export(readEX1x1)
 export(readLT1x1)
 export(readRegDeath)

R/HMDClasses.R

@@ -6,19 +6,24 @@ NULL
 NULL
 ####
 
-# S4 class definitions
-# class for life-tables 1x1
+## S4 class definitions
 
-#' LT1 Class
+
+#' LT1 class for life-tables 1x1
 #'
-#' A \code{LT1} is used to ..
+#' The class \code{LT1} stores life-table information in a systematic way.
+#' It fits to Human Mortality Database (HMD) 1x1 period life tables.
+#' See https://www.mortality.org/ for data details.
+#' An LT1 instance stores the raw header content and the life table as data.table.
+#' Further it adds a  pure numeric age AgeLow to the data.table.
 #'
 #' @slot content describes the content
-#' @slot country 
+#' @slot country regional entity
 #' @slot header includes the raw header information
 #' @slot lt1 ist the life table (data.table)
 #' @slot protocol contains the protocol information
 #' @export
+#' @rdname LT1-class
 setClass("LT1",
          slots=c(
            header="vector", # file header
@@ -29,8 +34,15 @@ setClass("LT1",
          )
 )
 
-# slot getters
+## slot getters
+
+#' LT1 header
+#'
+#' The \code{header}-method gets the raw header information of an LT1 object
+#' @param x LT1-object
+#' @return raw header information
 #' @export
+#' @rdname LT1-class
 setMethod("header", "LT1", function(x) x@header)
 #' @export
 setMethod("lt1", "LT1", function(x) x@lt1)
@@ -48,14 +60,30 @@ setReplaceMethod("lt1", "LT1", function(x, value) {x@lt1 <- value; validObject(x
 
 
 
-# constructor
+## constructor
+
+#' LT1 constructor
+#'
+#' The \code{LTable1}-constructor creates an LT1 object
+#' @param object header lt1 content country protocol
+#' @return LT1 object
 #' @export
+#' @rdname LT1-class
 LTable1 <- function(header, lt1, content, country, protocol)
   new("LT1", header=header, lt1=lt1, content=content, country=country, protocol=protocol)
 
-# methods
+## methods
+
+
+#' LT1 length
+#'
+#' The \code{length}-method gets the number of rows int the LT1 lt1 data.table
+#' @param x LT1-object
+#' @return number of rows
 #' @export
+#' @rdname LT1-class
 setMethod("length", "LT1", function(x) dim(x@lt1)[1])
+
 #' @export
 setMethod("show", "LT1",
           function(object)