improved documentation

DESCRIPTION

@@ -1,8 +1,8 @@
 Package: eoR
 Type: Package
 Title: Data Management Package (Exposure and Occurrence Data in R)
-Version: 0.3.0
-Date: 2019-10-16
+Version: 0.4.0
+Date: 2019-11-06
 Authors@R: c(person("Rainer", "Walke", role = c("aut", "cre"),
     email = "walke@demogr.mpg.de", 
     comment = c(ORCID = "0000-0002-4269-6531")))
@@ -11,8 +11,8 @@ Description: This data management package provides some helper
     Demography. Similar to ideas developed in the Bioconductor
     project bioconductor.org we strive to encapsulate data in easy
     to use S4 objects.
-    If original data is provided in a CSV file, the resulting S4
-    object contains all information from that CSV file. But the
+    If original data is provided in a text file, the resulting S4
+    object contains all information from that text file. But the
     information is somehow structured (header, footer, etc).
     Further the classes provide methods to make a subset for selected
     calendar years or selected regions. The resulting subset

R/GENESISClasses.R

@@ -18,6 +18,7 @@ NULL
 #' the version protocol and regional information and the
 #' death count information as a data.table object. Further it stores a second data.table
 #' with the total sums information.
+#' Try demo(RD1) for a demonstration.
 #'
 #' @slot content describes the content
 #' @slot region regional entity
@@ -208,6 +209,7 @@ setValidity("RD1",
 #' the version protocol and regional information and the
 #' exposure information as a data.table object. Further it stores a second data.table
 #' with the total sums information.
+#' Try demo(RE1) for a demonstration.
 #'
 #' @slot content describes the content
 #' @slot region regional entity

R/HMDClasses.R

@@ -19,6 +19,7 @@ NULL
 #' the version protocol and regional information and the
 #' life table as a data.table object.
 #' The validation adds a pure numeric age AgeLow to the life table.
+#' Try demo(LT1) for a demonstration.
 #'
 #' @slot content describes the content
 #' @slot region regional entity
@@ -177,6 +178,7 @@ setValidity("LT1",
 #' the version protocol and regional information and the
 #' exposure table as a data.table object.
 #' The validation adds a pure numeric age AgeLow to the exposure table.
+#' Try demo(EX1) for a demonstration.
 #'
 #' @slot content describes the content
 #' @slot region regional entity

README.md

@@ -1,4 +1,15 @@
 # eoR
 Data Management Package (Exposure and Occurrence Data in R)
 
+This data management package provides some helper
+classes for publicly available data sources (HMD, DESTATIS) in
+Demography. We strive to encapsulate data in easy to use S4 objects.
+
+If original data is provided in a text file, the resulting S4
+object contains all information from that text file. But the
+information is somehow structured (header, footer, etc).
+Further the classes provide methods to make a subset for selected
+calendar years or selected regions. The resulting subset
+objects still contain the original header and footer information.
+